@gooddata/typings - npm Package Compare versions

Comparing version 0.0.1-martin.mosko-mms-bb-343-2017-10-27T08-05-44-132Z to 0.0.1-pavelzgdc-pzb-header-items-2017-11-09T14-56-57-565Z

dist/index.d.ts

@@ -98,3 +98,2 @@ export declare namespace AFM {
     interface IDimension {
-        name: string;
         itemIdentifiers: Identifier[];
@@ -144,2 +143,7 @@ totals?: ITotalItem[];
     }
+    interface ITotalHeaderItem {
+        totalHeaderItem: {
+            name: string;
+        };
+    }
     interface IMeasureGroupHeader {
@@ -151,29 +155,33 @@ measureGroupHeader: {
     }
-    interface ITotalHeaderItem {
-        totalHeaderItem: {
+    interface IAttributeHeader {
+        attributeHeader: {
+            uri: string;
+            identifier: string;
+            localIdentifier: string;
             name: string;
+            totalItems?: ITotalHeaderItem[];
         };
     }
-    interface IAttributeHeaderItem {
+    type IHeader = IMeasureGroupHeader | IAttributeHeader;
+    interface IResultAttributeHeaderItem {
         attributeHeaderItem: {
             uri: string;
-            identifier: string;
             name: string;
         };
     }
-    interface IAttributeHeader {
-        attributeHeader: {
-            uri: string;
-            identifier: string;
-            localIdentifier: string;
+    interface IResultMeasureHeaderItem {
+        measureHeaderItem: {
             name: string;
-            items: IAttributeHeaderItem[];
-            totalItems?: ITotalHeaderItem[];
+            order: number;
         };
     }
-    type Header = IMeasureGroupHeader | IAttributeHeader;
+    interface IResultTotalHeaderItem {
+        totalHeaderItem: {
+            name: string;
+            type: string;
+        };
+    }
+    type IResultHeaderItem = IResultAttributeHeaderItem | IResultMeasureHeaderItem | IResultTotalHeaderItem;
     interface IResultDimension {
-        name: string;
-        headers: Header[];
-        totalData?: any;
+        headers: IHeader[];
     }
@@ -183,3 +191,3 @@ interface IExecutionResponse {
             links: {
-                uri: string;
+                executionResult: string;
             };
@@ -189,11 +197,29 @@ dimensions: IResultDimension[];
     }
+    type DataValue = null | string | number;
     interface IExecutionResult {
         executionResult: {
-            data: string[][] | string[];
+            headerItems?: IResultHeaderItem[][][];
+            data: DataValue[][] | DataValue[];
+            totals?: DataValue[][][];
+            paging: {
+                count: number[];
+                offset: number[];
+                total: number[];
+            };
         };
     }
-    interface IExecution {
+    interface IError extends Error {
+        response: {
+            status: number;
+        };
+    }
+    /**
+     * Combination of both AFM executions responses
+     *
+     * `null` value as executionResult means empty response (HTTP 204)
+     */
+    interface IExecutionResponses {
         executionResponse: IExecutionResponse;
-        executionResult: IExecutionResult;
+        executionResult: IExecutionResult | null;
     }
 }

index.ts

@@ -122,3 +122,2 @@ export namespace AFM {
     export interface IDimension {
-        name: string;
         itemIdentifiers: Identifier[];
@@ -190,2 +189,8 @@ totals?: ITotalItem[];
 
+    export interface ITotalHeaderItem {
+        totalHeaderItem: {
+            name: string;
+        }
+    }
+
     export interface IMeasureGroupHeader {
@@ -198,12 +203,17 @@ measureGroupHeader: {
 
-    export interface ITotalHeaderItem {
-        totalHeaderItem: {
+    export interface IAttributeHeader {
+        attributeHeader: {
+            uri: string;
+            identifier: string;
+            localIdentifier: string;
             name: string;
+            totalItems?: ITotalHeaderItem[];
         }
     }
 
-    export interface IAttributeHeaderItem {
+    export type IHeader = IMeasureGroupHeader | IAttributeHeader;
+
+    export interface IResultAttributeHeaderItem {
         attributeHeaderItem: {
             uri: string;
-            identifier: string;
             name: string;
@@ -213,19 +223,20 @@ }
 
-    export interface IAttributeHeader {
-        attributeHeader: {
-            uri: string;
-            identifier: string;
-            localIdentifier: string;
-            name: string;
-            items: IAttributeHeaderItem[];
-            totalItems?: ITotalHeaderItem[];
+    export interface IResultMeasureHeaderItem {
+        measureHeaderItem: {
+            name: string,
+            order: number
         }
     }
 
-    export type Header = IMeasureGroupHeader | IAttributeHeader;
+    export interface IResultTotalHeaderItem {
+        totalHeaderItem: {
+            name: string,
+            type: string
+        }
+    }
 
+    export type IResultHeaderItem = IResultAttributeHeaderItem | IResultMeasureHeaderItem | IResultTotalHeaderItem;
+
     export interface IResultDimension {
-        name: string;
-        headers: Header[];
-        totalData?: any;
+        headers: IHeader[];
     }
@@ -236,3 +247,3 @@
             links: {
-                uri: string;
+                executionResult: string;
             };
@@ -243,12 +254,32 @@ dimensions: IResultDimension[];
 
+    export type DataValue = null | string | number;
+
     export interface IExecutionResult {
         executionResult: {
-            data: string[][] | string[];
+            headerItems?: IResultHeaderItem[][][];
+            data: DataValue[][] | DataValue[];
+            totals?: DataValue[][][];
+            paging: {
+                count: number[];
+                offset: number[];
+                total: number[];
+            };
         }
     }
 
-    export interface IExecution {
+    export interface IError extends Error {
+        response: {
+            status: number;
+        };
+    }
+
+    /**
+     * Combination of both AFM executions responses
+     *
+     * `null` value as executionResult means empty response (HTTP 204)
+     */
+    export interface IExecutionResponses {
         executionResponse: IExecutionResponse;
-        executionResult: IExecutionResult;
+        executionResult: IExecutionResult | null;
     }
 }

package.json

 {
   "name": "@gooddata/typings",
-  "version": "0.0.1-martin.mosko-mms-bb-343-2017-10-27T08-05-44-132Z",
+  "version": "0.0.1-pavelzgdc-pzb-header-items-2017-11-09T14-56-57-565Z",
   "description": "TypeScript definition files for GoodData platform",
@@ -8,3 +8,4 @@ "typings": "dist/index.d.ts",
   "scripts": {
-    "prepublish": "rm -rf dist && tsc"
+    "prepublish": "rm -rf dist && tsc",
+    "dev": "tsc --watch --noEmit"
   },
@@ -11,0 +12,0 @@ "files": [

README.md

@@ -1,2 +0,46 @@
-# gooddata-typings
-TypeScript definition files for GoodData platform
+# GoodData Typings
+> TypeScript interfaces used in UI SDK describing executeAfm API
+
+## Getting started
+
+### Usage
+
+With [yarn](https://yarnpkg.com) installed, go to your project directory and run
+```
+$ yarn add -D @gooddata/typings
+```
+
+If you prefer [npm](npmjs.com) run
+```
+$ npm install --save-dev @gooddata/typings
+```
+
+## Documentation
+[Documentation](https://help.gooddata.com/display/bHsp5IhQjuz0e6HS0s76/React+Components)
+
+## Develop
+
+### Running the development
+
+To develop, you need to run the typescript compiler. By running `yarn dev`, the typescript compiler will be run in watch mode.
+```sh
+$ cd gooddata-typings
+$ yarn dev
+```
+
+
+### Deployment
+```
+git checkout master && git pull upstream master --tags
+npm version [major|minor|patch] -m "Release v%s"
+npm publish
+git push upstream master --tags
+```
+
+## Contributing
+Report bugs and features on our [issues page](https://github.com/gooddata/gooddata-typings/issues).
+
+## License
+Copyright (C) 2007-2017, GoodData(R) Corporation. All rights reserved.
+
+For more information, please see [LICENSE](https://github.com/gooddata/gooddata-typings/blob/master/LICENSE)

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18715

increased by29.41%

Number of package files

7

increased by16.67%

Lines of code

474

increased by12.32%

Number of lines in readme file

47

increased by1466.67%

No dependency changes