osuny-owl 1.0.0 → 1.1.0

package/index.js

@@ -1,11 +1,14 @@
 import 'dotenv/config'
 
+import fetch from 'node-fetch'
+
 export class OsunyOwl {
     constructor(website_id, api_url){
         this.website_id = website_id
         this.category_ids = []
         this.api_key_defined = process.env.OSUNY_API_KEY ? true : false
         this.api_url = api_url
+        this.last_media = undefined
     }
 
     set website_id(website_id){
@@ -46,14 +49,6 @@ export class OsunyOwl {
         }
     }
 
-    /**
-     * TODO
-     * 
-     *  - function : postToOsuny(Communication::Post object)
-     *          * Vérifier la connexion API
-     *          * Vérifier qu'il y ait un site
-     * 
-     */
 
     /**
      * Async function to post a Communication::Post object to a specific website
@@ -86,21 +81,89 @@ export class OsunyOwl {
             }
         } else {
             throw new Error("No API Key Defined")
+        } 
+    }
+
+    async importImage(img_bdy){
+
+        if(this.api_key_defined){
+            const url = this.api_url + "/communication/medias"
+            
+                try {
+                const response = await fetch(url, {
+                    method: "POST",
+                    headers:{
+                        "X-Osuny-Token": process.env.OSUNY_API_KEY
+                    },
+                    body: img_bdy
+                })
+
+                if (!response.ok){
+                    throw new Error(`Response status: ${response.status}, ${response.statusText}. Error: ${response.text()}`)
+                } else {
+                    
+                    let dataR = await response.json()
+                    this.last_media = dataR.original_blob
+                    return true
+                }
+            } catch (error) {
+                console.error(error.message)
+            }
+        } else {
+            throw new Error("No API Key Defined")
         }
-        
     }
 }
 
 export class OsunyUtility{
+
+    /**
+     * 
+     * @param {string} title **(Required)** Title to display 
+     * @param {*} migration_identifier **(Required)** A unique migration identifier
+     * @param {*} position **(Required)** The position of the block. The first element positionned in a post has the value : 0
+     * @param {*} layout (Optional) Layout of the block. By default set to 1. 1 = classic, 2 = collapsed,
+     * @returns Osuny's Communication::Block (Title) object
+     */
+    static createTitle(title, migration_identifier, position, layout = 1){
+        let layout_title;
+
+        switch (layout) {
+            case 1:
+                layout_title = "classic"
+                break;
+            
+            case 2:
+                layout_title = "collapsed"
+                break;
+            
+            default:
+                layout_title = "classic"
+                break;
+        }
+
+        return {
+            "id": null,
+            "migration_identifier": migration_identifier,
+            "template_kind": "title",
+            "title": title,
+            "position": position,
+            "published": true,
+            "html_class": null,
+            "data": {
+                "layout": layout_title
+            }
+        } 
+    }
     
     /**
      * Create a chapter Block to include in an Osuny's post
      * 
-     * @param {string} text - (Required) Main text of the chapter 
-     * @param {string} migration_identifier - (Required) a unique migration identifier
-     * @param {number} position - (Required) The position of the block. The first element positionned in a post has the value : 0
-     * @param {string} title - (Optional) Title of the block, will be displayed as h3 on the website
-     * @param {number} layout - Layout of the block. By default set to 1. 1 = no_background, 2 = alt_background, 3 = accent_background
+     * @param {string} text **(Required)** Main text of the chapter 
+     * @param {string} migration_identifier **(Required)** a unique migration identifier
+     * @param {number} position **(Required)** The position of the block. The first element positionned in a post has the value : 0
+     * @param {string} title (Optional) Title of the block, will be displayed as h3 on the website
+     * @param {number} layout Layout of the block. By default set to 1. 1 = no_background, 2 = alt_background, 3 = accent_background
      * @returns Osuny's Communication::Block (Chapter) object
      */
     
@@ -144,7 +207,7 @@ export class OsunyUtility{
     /**
      * Create a Datatable Block to include in an Osuny's Post
      * 
-     * @param {Array} table_data (Required) Array of objects with the following form
+     * @param {Array} table_data **(Required)** Array of objects with the following form
      *  ```
      *   { cells: [
      *      "value_1",
@@ -153,9 +216,9 @@ export class OsunyUtility{
      *   }
      * ```
      * - The number of strings in a "cells" array is representative of each cell in a row.
-     * @param {Array} table_headers (Required) Array of strings with all the columns header of the datatable
-     * @param {string} migration_identifier (Required) a unique migration identifier
-     * @param {number} position (Required) The position of the block. The first element positionned in a post has the value : 0
+     * @param {Array} table_headers **(Required)** Array of strings with all the columns header of the datatable
+     * @param {string} migration_identifier **(Required)** a unique migration identifier
+     * @param {number} position **(Required)** The position of the block. The first element positionned in a post has the value : 0
      * @param {string} title (Optional) Title of the block, will be displayed as h3 on the website
      * @param {boolean} alphabetical (Optional) Sort the datable in alphabetical order if set to true. False by default
      * @param {string} caption (Optional) Set the datable caption (usualy after the table). Set to an empty string by default.
@@ -181,6 +244,59 @@ export class OsunyUtility{
         }
     }
 
+    /**
+     * Create a Video Block to include in an Osuny's Post
+     * 
+     * @param {string} video_url **(Required)** The actual url of the video
+     * @param {string} migration_identifier (**Required)** A unique migration identifier
+     * @param {number} position **(Required)** Position of the block in the post
+     * @param {string} video_title Title of the video, will be displayed alongside the media
+     * @param {string} video_desc Description of the video, will be displayed as a paragraph alongside the media
+     * @param {string} video_transc (Recommended) Transcription of the video
+     * @param {string} title (Optional) Title of the block, will be displayed as h3 on the website
+     * @returns Osuny's Communication::Block (Video) object
+     */
+    static createVideo(video_url, migration_identifier, position, video_title = "", video_desc = "", video_transc = "", title = ""){
+        return {
+            "id": null,
+            "migration_identifier": migration_identifier,
+            "template_kind": "video",
+            "title": title,
+            "position": position,
+            "published": "true",
+            "html_class": null,
+            "data": {
+                "layout": "player",
+                "description": video_desc,
+                "url": video_url,
+                "video_title": video_title,
+                "transcription": video_transc
+            }
+        }
+    }
+
+    static createImage(img_id, img_filename, img_signedid, migration_identifier, position, alt="", credit="", text="", title = ""){
+        return {
+            "id": null,
+            "migration_identifier": migration_identifier,
+            "template_kind": "image",
+            "title": title,
+            "position": position,
+            "published": "true",
+            "html_class": null,
+            "data": {
+                "image": {
+                    "id": img_id,
+                    "filename": img_filename,
+                    "signed_id": img_signedid
+                },
+                "alt": alt,
+                "credit": credit,
+                "text": text
+            }
+        }
+    }
+
     /**
      * Create a post Object to publish on a Osuny website
      * 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osuny-owl",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Osuny Owl is an object that can go talk to the Osuny API, to create post or other osuny components from a large amount of data",
   "keywords": [
     "osuny",
@@ -15,6 +15,6 @@
   },
   "dependencies": {
     "dotenv": "^16.5.0",
-    "node-fetch": "^2.7.0"
+    "node-fetch": "^3.3.2"
   }
 }