Up maester client (#66)

Author: EmptyInfinity

.circleci/circle.yml

@@ -0,0 +1,40 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: circleci/node:16-stretch
+    steps:
+      - checkout
+      - restore_cache:
+          key: dependency-cache-{{ checksum "package-lock.json" }}
+      - run:
+          name: Installing Dependencies
+          command: npm install
+      - save_cache:
+          key: dependency-cache-{{ checksum "package-lock.json" }}
+          paths:
+            - ./node_modules
+      - run:
+          name: "Running audit"
+          command: npm audit --production
+      - run:
+          name: Running Mocha Tests
+          command: npm test
+
+workflows:
+  version: 2
+
+  build:
+    jobs:
+      - build
+
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - build

.circleci/config.yml

@@ -0,0 +1,2 @@
+ELASTICIO_OBJECT_STORAGE_TOKEN=feyJhbGciasfdJ0uhN__D0asdasdq283d283d
+ELASTICIO_OBJECT_STORAGE_URI=http://localhost:3002

.env.example

@@ -1,3 +1,9 @@
+## 3.0.0 (July 25, 2022)
+* Updated method `uploadAttachment` from `AttachmentProcessor`
+* Added method `getMaesterAttachmentUrlById` which return url to Maester attachment
+* Updated @elasticio/maester-client to v4.0.0
+* Updated Circle.ci config
+
 ## 2.1.0 (May 06, 2022)
 * Now method `uploadAttachment` from `AttachmentProcessor` automatically sets the `contentType`
 * Fixed retrying logic for method `uploadAttachment`

.github/ISSUE_TEMPLATE/1-bug-report.md

@@ -200,8 +200,11 @@ Contains functions to transform platform data that contains JSONata expressions
 ## Attachment Processor
 The attachment processor function can be used to store attachments on the platform. It exposes the following functions
 
-- `uploadAttachment(body, contentType)`, which will upload an attachment to the platform `Maester` storage and return the result object.
-Where `body` - attachment content, `contentType` - it's corresponding `Content-Type` value.
+- `uploadAttachment(getAttachment, retryOptions, contentType)`, which will upload an attachment to the platform `Maester` storage and return the result object.
+Where: <br>
+ `getAttachment` - async function which returns stream <br>
+ `retryOptions` - (optional): parameters for retrying of upload attachment, if request failed. Parameters are `retriesCount` and `requestTimeout`(ms)
+ `contentType` - (optional): `Content-Type` of attachment. By default `Content-Type` will be calculated automatically. <br>
 - `getAttachment(url, contentType)`, which will retrieve an attachment from `steward` or `maester` storage. To specify the storage - query parameter
 `storage_type` must be provided. To get items from `maester` storage - `?storage_type=maester` should added to the `url` argument. By default attachments are retrieved from `steward` storage, so `?storage_type=steward` is not obligated to be added to the `url` argument. `contentType` -
 one of [`stream`, `arraybuffer` ]
@@ -211,8 +214,10 @@ Example:
 ```javascript
 const { AttachmentProcessor } = require('@elastic.io/component-commons-library');
 
-const stream = new Stream();
-const result = await new AttachmentProcessor().uploadAttachment(body, 'application/octet-stream');
+const getAttachAsStream = async () => (
+  await axios.get('http://sample.pdf', { responseType: 'stream' })
+).data;
+const result = await new AttachmentProcessor().uploadAttachment(getAttachAsStream, 'application/pdf');
 
 const { objectId } = result.data;
 ```