@grapecity/activereports - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

lib/node_modules/@grapecity/ar-js-html.d.ts

 // Generated by dts-bundle v0.7.3
 // Dependencies for this module:
-//   ../@grapecity/ar-js-pagereport
-//   ../@grapecity/ar-js-pagereport/vDomRenderer
+//   ../../@grapecity/ar-js-pagereport
+//   ../../@grapecity/ar-js-pagereport/vDomRenderer
 
 declare module '@grapecity/ar-js-html' {
+    /** @hidden */ /** */
     export * from '@grapecity/ar-js-html/export';
@@ -11,15 +12,41 @@ }
 declare module '@grapecity/ar-js-html/export' {
+    /** @module HtmlExport */ /** */
     import * as ARJS from '@grapecity/ar-js-pagereport';
+    import { HtmlSettings, HtmlExportResult, CheckCancelCallback, OnProgressCallback } from '@grapecity/ar-js-html/types';
+    /**
+        * Exports a provided PageDocument to the HTML format and returns it as string or Blob.
+        * @param source PageDocument to export.
+        * @param settings Export settings.
+        * @param onProgress The callback that gets called after each sheet is rendered.
+        * @param checkCancel The callback that gets called before sheet rendering, the rendering process will be canceled if the function returns _true_.
+        */
+    export function exportDocument(source: ARJS.PageDocument | ARJS.VDomRenderer, settings?: HtmlSettings, onProgress?: OnProgressCallback, checkCancel?: CheckCancelCallback): Promise<HtmlExportResult>;
+}
+
+declare module '@grapecity/ar-js-html/types' {
+    /** @module HtmlExport */ /** */
     import { RenderOptions } from '@grapecity/ar-js-pagereport/vDomRenderer';
+    /** Defines HTML export settings. */
     export type HtmlSettings = {
-        multiPage?: boolean;
-        autoPrint?: boolean;
-        title?: string;
-        renderOptions?: RenderOptions;
+            /** Set to _true_ to export as a ZIP archive with pages, set to _false_ to export all report pages as a single HTML page. */
+            multiPage?: boolean;
+            /** Set to _true_ to add script for a printing page when it is loaded. */
+            autoPrint?: boolean;
+            /** A title for an HTML page. */
+            title?: string;
+            /** @hidden Galley mode and interactivity settings */
+            renderOptions?: RenderOptions;
     };
-    export function exportDocument(source: ARJS.PageDocument | ARJS.VDomRenderer, settings?: HtmlSettings, onProgress?: (pageCount: number) => void, checkCancel?: () => boolean): Promise<{
-        data: Blob | string;
-        download: (filename?: string) => void;
-    }>;
+    /** Export result. */
+    export type HtmlExportResult = {
+            /** Result content. The content is 'string' if 'multiPage = true', otherwise content is zip blob. */
+            data: Blob | string;
+            /** Triggers browser download of file with export result. */
+            download: (filename?: string) => void;
+    };
+    /** Defines a type of callback that gets called after each page is rendered. */
+    export type OnProgressCallback = (pageNumber: number) => void;
+    /** Defines a type of callback that gets called to check if cancellation was requested. */
+    export type CheckCancelCallback = () => boolean;
 }
 

lib/node_modules/@grapecity/ar-js-pdf.d.ts

 // Generated by dts-bundle v0.7.3
 // Dependencies for this module:
-//   ../@grapecity/ar-js-pagereport
-//   ../@grapecity/ar-js-pagereport/vDomRenderer
+//   ../../@grapecity/ar-js-pagereport
+//   ../../@grapecity/ar-js-pagereport/vDomRenderer
 
 declare module '@grapecity/ar-js-pdf' {
+    /** @hidden */ /** */
     export * from '@grapecity/ar-js-pdf/export';
@@ -11,52 +12,112 @@ }
 declare module '@grapecity/ar-js-pdf/export' {
+    /** @module PdfExport */ /** */
     import * as ARJS from '@grapecity/ar-js-pagereport';
-    import { PdfSettings } from '@grapecity/ar-js-pdf/types';
+    import { PdfSettings, PdfExportResult, OnProgressCallback, CheckCancelCallback } from '@grapecity/ar-js-pdf/types';
     export { registerPdfFont } from '@grapecity/ar-js-pdf/registerFonts';
-    export function exportDocument(source: ARJS.PageDocument | ARJS.VDomRenderer, settings?: PdfSettings, onProgress?: (pageCount: number) => void, checkCancel?: () => boolean): Promise<{
-        data: Blob | string;
-        download: (filename?: string) => void;
-    }>;
+    /**
+        * Exports a provided PageDocument to the PDF format and returns it as Data URI or Blob.
+        * @param source PageDocument to export.
+        * @param settings Export settings.
+        * @param onProgress The callback that gets called after each sheet is rendered.
+        * @param checkCancel The callback that gets called before sheet rendering, the rendering process will be canceled if the function returns _true_.
+        */
+    export function exportDocument(source: ARJS.PageDocument | ARJS.VDomRenderer, settings?: PdfSettings, onProgress?: OnProgressCallback, checkCancel?: CheckCancelCallback): Promise<PdfExportResult>;
 }
 
 declare module '@grapecity/ar-js-pdf/types' {
+    /** @module PdfExport */ /** */
     import { RenderOptions } from '@grapecity/ar-js-pagereport/vDomRenderer';
+    /** Defines descriptor of font. */
     export type PdfFontDescriptor = {
-        name: string;
-        source: string;
-        weight?: string;
-        style?: string;
+            /** Font name. */
+            name: string;
+            /** The source of the font. */
+            source: string | string[];
+            /** The font weight. */
+            weight?: string;
+            /** The font style. */
+            style?: string;
+            /** The font postscript name. */
+            postscriptName?: string;
+            /** True - to use the font as default font. */
+            useAsDefault?: boolean;
     };
+    /** The version of PDF specification. */
     export type PdfVersion = '1.3' | '1.4' | '1.5' | '1.6' | '1.7' | '1.7ext3';
-    export type DocumentSecurity = {
-        userPassword?: string;
-        ownerPassword?: string;
-        permissions?: {
+    /** Defines PDF permissions. */
+    export type Permissions = {
+            /** Allows printing. */
             printing?: 'lowResolution' | 'highResolution' | 'none';
+            /** Allows modifying. */
             modifying?: boolean;
+            /** Allows copying. */
             copying?: boolean;
+            /** Allows annotating. */
             annotating?: boolean;
+            /** Enables content accessibility. */
             contentAccessibility?: boolean;
+            /** Allows document assembly. */
             documentAssembly?: boolean;
-        };
     };
-    export type PdfSettings = {
-        info?: {
+    /** Defines document security settings. */
+    export type DocumentSecurity = {
+            /** Encrypts a document with a password. */
+            userPassword?: string;
+            /** Protects a document from printing or modifying, see [[Permissions]]. */
+            ownerPassword?: string;
+            /** The document permissions. */
+            permissions?: Permissions;
+    };
+    /** Defines PDF metadata. */
+    export type PdfSettingsInfo = {
+            /** Title */
             title?: string;
+            /** Author */
             author?: string;
+            /** keywords */
             keywords?: string;
+            /** Subject */
             subject?: string;
-        };
-        security?: DocumentSecurity;
-        pdfVersion?: PdfVersion;
-        autoPrint?: boolean;
-        fonts?: PdfFontDescriptor[];
-        renderOptions?: RenderOptions;
     };
+    /** Defines PDF export settings. */
+    export type PdfSettings = {
+            /** Document metadata. */
+            info?: PdfSettingsInfo;
+            /** Document security settings. */
+            security?: DocumentSecurity;
+            /** PDF Version. */
+            pdfVersion?: PdfVersion;
+            /** Prints a document on opening the file. */
+            autoPrint?: boolean;
+            /** Available *.ttf font files. */
+            fonts?: PdfFontDescriptor[];
+            /** @hidden */
+            renderOptions?: RenderOptions;
+    };
+    /** Export result. */
+    export type PdfExportResult = {
+            /** Result content. */
+            data: Blob;
+            /** Triggers browser download of file with export result. */
+            download: (filename?: string) => void;
+    };
+    /** Defines a type of callback that gets called after each page is rendered. */
+    export type OnProgressCallback = (pageNumber: number) => void;
+    /** Defines a type of callback that gets called to check if cancellation was requested. */
+    export type CheckCancelCallback = () => boolean;
 }
 
 declare module '@grapecity/ar-js-pdf/registerFonts' {
+    /** @module PdfExport */ /** */
     import { PdfFontDescriptor } from '@grapecity/ar-js-pdf/types';
+    /**
+        * @hidden Internal fonts store
+        */
     export const fontsStore: PdfFontDescriptor[];
+    /**
+        * Registers .*ttf fonts to be used in PDF.
+        * @param fontDescriptor
+        */
     export const registerPdfFont: (fontDescriptor: PdfFontDescriptor) => number;
 }
 

lib/node_modules/@grapecity/ar-js-xlsx.d.ts

 // Generated by dts-bundle v0.7.3
 // Dependencies for this module:
-//   ../@grapecity/ar-js-pagereport
-//   ../@grapecity/ar-js-pagereport/vDomRenderer
+//   ../../@grapecity/ar-js-pagereport
+//   ../../@grapecity/ar-js-pagereport/vDomRenderer
 
 declare module '@grapecity/ar-js-xlsx' {
+    /** @hidden */ /** */
     export * from '@grapecity/ar-js-xlsx/export';
@@ -11,22 +12,57 @@ }
 declare module '@grapecity/ar-js-xlsx/export' {
+    /** @module XlsxExport */ /** */
     import * as ARJS from '@grapecity/ar-js-pagereport';
+    import { XlsxSettings, XlsxExportResult, OnProgressCallback, CheckCancelCallback } from '@grapecity/ar-js-xlsx/types';
+    /**
+        * Exports a provided PageDocument to the XLSX format and returns it as Blob.
+        * @param source The document to export.
+        * @param settings Export settings.
+        * @param onProgress The callback that gets called after each sheet is rendered.
+        * @param checkCancel The callback that gets called before sheet rendering, the render process will be canceled if the function returns _true_.
+        */
+    export function exportDocument(source: ARJS.PageDocument | ARJS.VDomRenderer, settings?: XlsxSettings, onProgress?: OnProgressCallback, checkCancel?: CheckCancelCallback): Promise<XlsxExportResult>;
+}
+
+declare module '@grapecity/ar-js-xlsx/types' {
+    /** @module XlsxExport */ /** */
     import { RenderOptions } from '@grapecity/ar-js-pagereport/vDomRenderer';
+    /** Page size */
     export type PageSize = 'Letter' | 'Legal' | 'Executive' | 'A4' | 'A5' | 'B5' | 'Envelope_10' | 'Envelope_DL' | 'Envelope_C5' | 'Envelope_B5' | 'Envelope_Monarch' | 'Double_Japan_Postcard_Rotated' | 'K16_197x273_mm';
-    export type XlsxSettings = {
-        info?: {
+    /** Xlsx info */
+    export type XlsxSettingsInfo = {
+            /** Creator */
             creator?: string;
-        };
-        sheetName?: string;
-        pageSettings?: {
+    };
+    /** Page settings. */
+    export type PageSettings = {
+            /** Page orientation. */
             orientation?: 'portrait' | 'landscape';
+            /** Page size. */
             size?: PageSize;
-        };
-        password?: string;
-        renderOptions?: RenderOptions;
     };
-    export function exportDocument(source: ARJS.PageDocument | ARJS.VDomRenderer, settings?: XlsxSettings, onProgress?: (pageCount: number) => void, checkCancel?: () => boolean): Promise<{
-        data: Blob | string;
-        download: (filename?: string) => void;
-    }>;
+    /** Xlsx export settings. */
+    export type XlsxSettings = {
+            /** Document metadata. */
+            info?: XlsxSettingsInfo;
+            /** The sheet name prefix, e.g. "Sheet_". */
+            sheetName?: string;
+            /** Page settings. */
+            pageSettings?: PageSettings;
+            /** Encrypts a document with a password. */
+            password?: string;
+            /** @hidden */
+            renderOptions?: RenderOptions;
+    };
+    /** Export result */
+    export type XlsxExportResult = {
+            /** Result content. */
+            data: Blob;
+            /** Triggers browser download of file with export result. */
+            download: (filename?: string) => void;
+    };
+    /** The type of callback that gets called after each sheet is rendered. */
+    export type OnProgressCallback = (pageNumber: number) => void;
+    /** The type of callback that gets called before sheet rendering, the render process will be canceled if the function returns _true_. */
+    export type CheckCancelCallback = () => boolean;
 }
 

package.json

@@ -1,1 +0,44 @@
-{"name":"@grapecity/activereports","version":"1.0.0","description":"ActiveReportsJS","author":"GrapeCity, Inc.","main":"./index.js","types":"./index.d.ts","license":"Commercial","publishConfig":{},"keywords":["activereports","arjs","reporting","pagereport","pagedocument","rdlx","rdl"],"dependencies":{"@types/lodash-es":"^4.17.1","@types/ramda":"^0.25.0","@types/virtual-dom":"^2.0.27","i18next":"^15.1.3","lodash-es":"^4.17.11","moment":"^2.22.2","ramda":"^0.25.0","virtual-dom":"^2.1.1"}}
+{
+  "name": "@grapecity/activereports",
+  "version": "1.1.0",
+  "description": "ActiveReportsJS",
+  "author": "GrapeCity, Inc.",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "license": "Commercial",
+  "keywords": [
+    "activereports",
+    "arjs",
+    "reporting",
+    "pagereport",
+    "pagedocument",
+    "rdlx",
+    "rdl",
+    "javascript",
+    "report designer",
+    "web designer",
+    "viewer",
+    "pdf",
+    "excel",
+    "アクティブレポート",
+    "帳票",
+    "ページレポート",
+    "RDLレポート",
+    "レポートデザイナ",
+    "ビューワ",
+    "エクセル",
+    "バーコード",
+    "グラフ"
+  ],
+  "dependencies": {
+    "@types/lodash-es": "^4.17.1",
+    "@types/ramda": "^0.25.0",
+    "@types/virtual-dom": "^2.0.27",
+    "i18next": "^15.1.3",
+    "lodash-es": "^4.17.11",
+    "moment": "^2.22.2",
+    "ramda": "^0.25.0",
+    "virtual-dom": "^2.1.1",
+    "xregexp": "^3.0.30"
+  }
+}

readme.MD

@@ -0,1 +1,4 @@
+### [English](#activereportsjs) | [日本語](#activereportsjs-jp) | [中文](#activereportsjs-cn)
+____
+
 # ActiveReportsJS
@@ -51,5 +54,5 @@
 
-2. if IE11 support is needed, in `index.html` in head section (above `ar-js-core.js` and `ar-js-viewer.js`) add reference to `ie-polyfills.full.js` from `dist` folder:
+2. if IE11 support is needed, in `index.html` in head section (above `ar-js-core.js` and `ar-js-viewer.js`) add reference to `ie-polyfills.js` from `dist` folder:
 ```html
-    <script src="/dist/ie-polyfills.full.js"></script>
+    <script src="/dist/ie-polyfills.js"></script>
 ```
@@ -66,3 +69,3 @@
 ```html
-    <div id="root" style="height: 100%"></div>
+    <div id="root" style="height: 100vh"></div>
 ```
@@ -90,3 +93,3 @@
 
-    <div id="root" style="height: 100%"></div>
+    <div id="root" style="height: 100vh"></div>
 </body>
@@ -100,2 +103,120 @@ ```
 
-To create and modify reports, you will need **ActiveReportsJS Designer**. Download the ActiveReportsJS designer [here](https://www.grapecity.com/activereportsjs/) for  MacOS, Win, or Linux, to get started.
+To create and modify reports, you will need **ActiveReportsJS Designer**. Download the ActiveReportsJS designer [here](https://www.grapecity.com/activereportsjs/) for  MacOS, Win, or Linux, to get started.
+
+# ActiveReportsJS JP
+[ActiveReportsJS](https://www.grapecity.co.jp/developer/activereportsjs)は、モダンなWebアプリケーションに帳票出力機能を組み込めるJavaScriptコントロールです。帳票の外観デザインの設定からデータ接続、印刷、PDFやExcelへの出力まで、Web帳票開発に必要な機能が揃っています。
+
+## サンプル
+[ActiveReportsJSチュートリアルデモ](https://demo.grapecity.com/activereportsjs/demos/)では、ActiveReportsJSを使用したアプリケーションの作成方法や、各コントロールの基本機能、実用的なアプリケーションの例などを紹介しています。
+
+また、[トライアル版](https://www.grapecity.co.jp/developer/download#javascript)をダウンロードして、実際の機能や動作をご確認いただけます。
+
+## インストール方法
+```sh
+npm install @grapecity/activereports
+```
+日本語版での動作保証は日本語版サイトで公開しているバージョンのみとなります。
+
+## ドキュメント
+製品の各種ドキュメントは、下記をご参照ください。
+- [製品ヘルプ](https://demo.grapecity.com/activereportsjs/docs/)
+- [チュートリアルデモ](https://demo.grapecity.com/activereportsjs/demos/)
+
+## 製品情報
+製品の詳細や価格、ライセンスについては、下記をご参照ください。
+[https://www.grapecity.co.jp/developer/activereportsjs](https://www.grapecity.co.jp/developer/activereportsjs)
+
+
+# ActiveReportsJS CN
+
+
+* ActiveReportsJS 是一个轻量级的报表解决方案，为您提供简单易用的丰富的 API ，创建复杂报表，轻松集成到您的项目重 为了满足常用的报表布局需求，不需要依赖于服务端。
+
+* ActiveReportsJS支持以下报表类型："页面" 和"RDL 报表"。
+
+
+
+
+## 安装
+
+使用命令 `npm install @grapecity/activereports` 安装 ActiveReportsJS
+
+
+
+## 产品资料
+
+
+更多产品资料请点击 [帮助文档](https://demo.grapecity.com.cn/activereportsjs/docs/GettingStarted/Introduction) 或 [API 文档](https://demo.grapecity.com.cn/activereportsjs/api/) 。
+
+
+
+## 示例
+
+
+ [ActiveReportsJS 示例](https://demo.grapecity.com.cn/activereportsjs/demos/Reports/InvoiceList/purejs).
+
+
+
+
+
+## 入门指南 - 创建第一个 **ActiveReportsJS Viewer** 应用 
+
+
+
+### 操作步骤
+
+1. 在 `index.html` head 标签内添加 `dist`文件夹中的 js 文件的引用， `ar-js-core.js` 、 `ar-js-viewer.js`   及`styles` 文件夹中的css文件 `ar-js-viewer.css`  :
+```html
+    <link rel="stylesheet" type="text/css" href="/styles/ar-js-viewer.css">
+
+    <script src="/dist/ar-js-core.js"></script>
+    <script src="/dist/ar-js-viewer.js"></script>
+```
+
+2. 如果需要支持 IE11 , 也需要在 `index.html` head标签内添加`ie-polyfills.js`文件 (具体位置要在 `ar-js-core.js` 和 `ar-js-viewer.js`文件前面引用) 
+```html
+    <script src="/dist/ie-polyfills.js"></script>
+```
+
+3. 如果需要支持导出按钮， 需要添加  `ar-js-pdf.js`, `ar-js-html.js` 及 `ar-js-xlsx.js`  `dist` 文件夹的引用:
+```html
+    <script src="/dist/ar-js-pdf.js"></script>
+    <script src="/dist/ar-js-html.js"></script>
+    <script src="/dist/ar-js-xlsx.js"></script>
+```
+
+4. 在 `index.html` body 标签内声明 div 用于展示 *ActiveReportsJS Viewer*。 注意, 必须要定义height属性:
+```html
+    <div id="root" style="height: 100vh"></div>
+```
+
+5. 在 `index.html`  body `onload` 事件中添加以下脚本:
+```html
+<body onload="loadViewer()">
+    <script>
+        function loadViewer() {
+            var viewer = new ActiveReports.Viewer('#root');
+            viewer.open({
+              "Name": "Report",
+              "Type": "report",
+              "Body": {
+                "Name": "Body",
+                "Type": "section",
+                "ReportItems": [
+                   { Type: "textbox", Name: "textbox1", Value: "Hello from ActiveReports", Top: "3in", Left: "3in", Height: "1in" }
+                 ]
+               }
+            });
+        }
+     </script>
+
+    <div id="root" style="height: 100vh"></div>
+</body>
+```
+
+
+## 设计器
+
+
+
+我们提供了 Windows,Mac,Linux 三个版本的设计器报表设计器 **ActiveReportsJS Designer**。下载[设计器](https://downloads.grapecity.com.cn/ActiveReportsJS/ActiveReportsJS_Beta.zip) 

New alerts

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Fixed alerts

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12955597

increased by3.19%

Number of lines in readme file

218

increased by124.74%

Number of medium supply chain risk alerts

20

decreased by-23.08%

Worsened metrics

Dependency count

9

increased by12.5%

Number of package files

41

decreased by-2.38%

Lines of code

26485

decreased by-28.93%

Dependency changes

• + Addedxregexp@^3.0.30

• + Addedxregexp@3.2.0(transitive)