@devoinc/app-developer-kit - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

devoApp/DevoApp.Interface.d.ts

@@ -25,3 +25,3 @@ import { IClient as IAlertsClient } from '@devoinc/alerts-api-client';
     /**
-     * Create a notipop alert on the screen.
+     * Create a notification on the screen.
      *
@@ -28,0 +28,0 @@ * @public

DevoAppProvider.d.ts

 import { IDevoApp } from './devoApp/DevoApp.Interface';
 import { DevoAppConfig } from './types';
 /**
- * Static class that provides DevoApp instance.
+ * Static class that provides a DevoApp instance.
  *
@@ -11,3 +11,3 @@ * @public
     /**
-     * Initialize Devo browser app.
+     * Initialize DevoApp instance.
      *
@@ -22,3 +22,3 @@ * @public
     /**
-     * Get DevoAppInstance
+     * Get previusly initialized DevoApp instance.
      *
@@ -25,0 +25,0 @@ * @public

package.json

 {
   "name": "@devoinc/app-developer-kit",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Devo Web Browser Applications Development Kit",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -7,2 +7,6 @@ # Devo Applications Developer Kit
 
+## Devo Apps
+
+A Devo App is a front-end web browser extension capable of being injected and hosted into the Devo web platform as well as communicating with it and with the collection of HTTP services enabled for Devo customers.
+
 ## Before starting
@@ -16,6 +20,6 @@
 
-Start by installing this package in your npm project
+Start by installing this package in your NPM project
 
 ```npm
-$ npm install @devo/applications-developer-kit
+$ npm install @devoinc/app-developer-kit
 ```
@@ -25,7 +29,7 @@
 
-Some configuration examples can be found in the [react template project]().
+A complete usage example for this package can be found in this [react template](https://github.com/DevoInc/App-Template).
 
 ## Features
 
-You can find the complete documentation of the development kit [here]().
+You can find the complete reference of the development kit API [here](https://devoinc.github.io/App-Developer-Kit/).
 
@@ -40,3 +44,3 @@ - **User information**:
     UserInfo,
-} from '@devo/applications-developer-kit';
+} from '@devoinc/app-developer-kit';
 
@@ -58,3 +62,3 @@ (async () => {
     NotipopRequest,
-} from '@devo/applications-developer-kit';
+} from '@devoinc/app-developer-kit';
 
@@ -73,3 +77,3 @@ (async () => {
 - **Devo queries**:
-The IDevoApp instance could be used to make queries on Devo query engine. You could found a complete documentation about Devo queries [here]().
+The IDevoApp instance could be used to make queries on Devo query engine. The different operations provided here are a wrapper of this other [package](https://github.com/DevoInc/browser-sdk). It is intended to be consumed in a simple way with async/await syntax and masking the obtaining of the user credentials as well as the service URL.
 
@@ -82,3 +86,3 @@ ```ts
     NotipopRequest 
-} from '@devo/applications-developer-kit';
+} from '@devoinc/app-developer-kit';
 
@@ -105,3 +109,3 @@ (async () => {
 - **Devo alerts**:
-The IDevoApp instance could be used to operate with Devo alerts. You could found a complete documentation about Devo alerts [here]() and the client reference [here]().
+The IDevoApp instance could be used to operate with Devo alerts. You could found a complete documentation about Devo alerts [here](https://docs.devo.com/space/latest/95128644/Alerts%20API) and the client reference [here](https://devoinc.github.io/alerts-api-client/).
 
@@ -113,3 +117,3 @@ ```ts
     AlertsApiClient,
-} from '@devo/applications-developer-kit';
+} from '@devoinc/app-developer-kit';
 
@@ -126,3 +130,3 @@ (async () => {
 
-It is possible to initialize the IDevoApp instance to work in standalone mode, in this way, the different dependencies of the application with the web and API endpoints could be mocked. Just use the init method passing it a specific settings for the 'mockData' field as in the following example.
+It is possible to initialize the IDevoApp instance to work in standalone mode, in this way, the different dependencies of the application with the Devo web core and API endpoints could be mocked. Just use the init method passing it a specific settings for the 'standaloneDependencies' field as the following example.
 
@@ -135,5 +139,11 @@ ```ts
     Dates,
-} from '@devo/applications-developer-kit';
+} from '@devoinc/app-developer-kit';
 
 (async () => {
+    class StandaloneNotipop {
+        constructor(request: NotiPopRequest) {
+            console.log(`Fake notification`, request);
+        }
+    }
+
     const mockedUserInfo: UserInfo = {
@@ -145,9 +155,12 @@ name: 'John Doe',
     };
+
     const mockedGoToQuery: (query: string, dates: Dates) => {
         console.log(`Fake goToQuery. ${query} ${dates}`);
     };
+
     const dApp: IDevoApp = DevoAppProvider.init({
-        mockData: {
+        standaloneDependencies: {
             goToQuery: mockedGoToQuery,
             userInfo: mockedUserInfo,
+            NotiPop: StandaloneNotipop,
         },
@@ -157,1 +170,5 @@ });
 ```
+
+## Publishing and hosting
+
+The publishing and hosting process for these applications will be carried out by Devo employees. Please contact [Devo support](https://www.devo.com/legal-hub/support-services/) for this task.

types/Dates.d.ts

 /**
- * From/to date object
+ * From/to date type.
  *
@@ -4,0 +4,0 @@ * @public

types/DevoAppConfig.d.ts

 import { WebCoreRuntimeDeps } from './WebCoreRuntimeDeps';
 /**
- * Configuration for a Devo App initialization
+ * Configuration for a Devo App initialization.
  *
@@ -11,2 +11,7 @@ * @public
      *
+     * @remarks
+     *
+     * This field is used to override the default WebCoreRuntimeDeps
+     * from Devo web core in a standalone mode.
+     *
      * @public
@@ -22,3 +27,3 @@ */
     /**
-     * Callback to be called when the Web core destroys the app container
+     * Callback to be called when the web core unmounts the app container.
      *
@@ -25,0 +30,0 @@ * @public

types/NotiPopPosition.d.ts

 /**
- * Different positions notipops could have in the screen.
+ * Different positions that notifications could have in the screen.
  */
 export declare type NotiPopPosition = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';

types/NotiPopRequest.d.ts

@@ -5,3 +5,3 @@ import { NotiPopPosition } from './NotiPopPosition';
 /**
- * Request to create a notipop on the browser
+ * Request to create a notification on the screen.
  *
@@ -8,0 +8,0 @@ * @public

types/NotiPopSize.d.ts

 /**
- * Different sizes notipops could have in the screen.
+ * Different sizes that notifications could have in the screen.
  */
 export declare type NotiPopSize = 'lg' | 'md' | 'sm';

types/NotiPopType.d.ts

 /**
- * Types of Notipops.
+ * Different types of notifications.
  *
@@ -4,0 +4,0 @@ * @public

types/Query.d.ts

 import { Dates } from './Dates';
 /**
- * Devo query
+ * Devo query.
  *
@@ -5,0 +5,0 @@ * @public

types/QueryResponseResult.d.ts

 /**
- * query result types as number or strings;
+ * query result types as number or strings.
  *
@@ -8,3 +8,3 @@ * @public
 /**
- * Query response result as a diccionary of QueryResultType
+ * Query response result as a diccionary of QueryResultType.
  *
@@ -11,0 +11,0 @@ * @public

types/UserApplication.d.ts

 /**
- * Current user application
+ * Current user application.
  *
@@ -4,0 +4,0 @@ * @public

types/UserCredentials.d.ts

 /**
- * Current user credentials
+ * Current user credentials.
  *
@@ -4,0 +4,0 @@ * @public

types/UserInfo.d.ts

@@ -5,3 +5,3 @@ import { UserApplication } from './UserApplication';
 /**
- * Current user info from webcore.
+ * Current user information.
  *
@@ -8,0 +8,0 @@ * @public

types/UserVault.d.ts

 /**
- * Current user vault from webcore.
+ * Current user vault.
  *
@@ -4,0 +4,0 @@ * @public

types/WebCoreRuntimeDeps.d.ts

 import { Dates } from './Dates';
 import { UserInfo } from './UserInfo';
 /**
- * Web core dependencies type.
+ * Devo web core dependencies.
  *
  * @remarks
  * This type is based on the current WebCore dependency implementation.
- * If you want to use a different implementation for a standalon app,
- * you can implement this interface in a new custom object.
+ * if you want to override these dependencies for a standalone mode,
+ * use the DevoAppProvider's init method with a custom object based on this type.
  *
@@ -15,3 +15,3 @@ * @public
     /**
-     * goToQuery function that redirects to query search UI
+     * goToQuery function that redirects to query search tab of Devo web.
      */
@@ -24,3 +24,3 @@ readonly goToQuery: (query: string, dates: Dates) => void;
      * This field contain a class that is used to create a notipop alert on the screen.
-     * If you want to use a different implementation for a standalon app,
+     * If you want to use a different implementation for a standalon mode,
      * simply declare a class and pass it here.
@@ -27,0 +27,0 @@ * A NotiPopRequest will be passed to the constructor.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

67742

increased by1.98%

Lines of code

731

increased by0.69%

Number of lines in readme file

162

increased by11.72%

No dependency changes