copper-sdk 0.7.1 → 0.8.0

package/CHANGELOG.md

@@ -1,7 +1,18 @@
+## 0.8.0
+
+### Development
+
+* Use Node 18
+* Replace Gitbook with Docusaurus for doc generation
+
 ## 0.7.1
 
+### Bugfixes
+
 * Add support for parallel asynchronous requests
 
 ## 0.7.0
 
+### Development
+
 * Bump all dependencies as far as they can go on Node 10

package/README.md

@@ -4,9 +4,9 @@ Copper App SDK
 [![npm](https://img.shields.io/npm/v/copper-sdk.svg?style=flat-square)](https://www.npmjs.com/package/copper-sdk)
 
 
-The javascript SDK provides client-side functionalities for adding embedded app to the Copper web client.
+The javascript SDK provides client-side functionalities for adding embedded apps to the Copper web client.
 
-The Embedded app is an iframe embedded in the Copper web page. The display location of the iframe is configured in the embedded app's settings page.
+The embedded app is an iframe embedded in the Copper web page. The display location of the iframe is configured in the embedded app's settings page.
 
 ## Usage
 Execute the following with your webpack/rollup/browserify etc.
@@ -43,16 +43,13 @@ sdk.getContext()
 </script>
 ```
 
-### SDK Docs
-
-https://docs.copper.com/copper-sdk
 
 ## Development
 ### Prerequisites
 
-We recommend Node 10 or newer.
+We recommend Node 18 or newer.
 
-Confirm all packages have been installed before development. Yarn will be used for this particular project.
+Confirm all packages have been installed. This project uses yarn for package management.
 
 ```bash
 yarn

package/dist/action-data-generator.d.ts

@@ -1,20 +1,20 @@
-import { ENTITY_TYPE } from './constant';
-import { IEntityModel } from './entity-model';
-import { IActionApiData } from './interfaces';
-export declare function logActivityDataGenerator(context: IEntityModel, { activityType, details, activityDate, }: {
-    activityType: number;
-    details: string;
-    activityDate?: number;
-}): IActionApiData;
-export declare function createEntityDataGenerator(context: IEntityModel, { entityType, data, }: {
-    entityType: ENTITY_TYPE;
-    data: any;
-}): IActionApiData;
-export declare function relateEntityDataGenerator(context: IEntityModel, { entityType, entityId, data, }: {
-    entityType: ENTITY_TYPE;
-    entityId: number;
-    data: {
-        id: number;
-        type: ENTITY_TYPE;
-    };
-}): IActionApiData;
+import { ENTITY_TYPE } from './constant';
+import { IEntityModel } from './entity-model';
+import { IActionApiData } from './interfaces';
+export declare function logActivityDataGenerator(context: IEntityModel, { activityType, details, activityDate, }: {
+    activityType: number;
+    details: string;
+    activityDate?: number;
+}): IActionApiData;
+export declare function createEntityDataGenerator(context: IEntityModel, { entityType, data, }: {
+    entityType: ENTITY_TYPE;
+    data: any;
+}): IActionApiData;
+export declare function relateEntityDataGenerator(context: IEntityModel, { entityType, entityId, data, }: {
+    entityType: ENTITY_TYPE;
+    entityId: number;
+    data: {
+        id: number;
+        type: ENTITY_TYPE;
+    };
+}): IActionApiData;

package/dist/constant.d.ts

@@ -1,10 +1,10 @@
-export declare type HTTP_METHOD = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
-export declare type ENTITY_TYPE = 'lead' | 'person' | 'company' | 'opportunity' | 'task' | 'project';
-export declare const ENTITY_PATH_MAP: {
-    lead: string;
-    person: string;
-    company: string;
-    opportunity: string;
-    task: string;
-    project: string;
-};
+export type HTTP_METHOD = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+export type ENTITY_TYPE = 'lead' | 'person' | 'company' | 'opportunity' | 'task' | 'project';
+export declare const ENTITY_PATH_MAP: {
+    lead: string;
+    person: string;
+    company: string;
+    opportunity: string;
+    task: string;
+    project: string;
+};