osuny-owl 1.0.1-alpha → 1.1.1

package/index.js

@@ -116,15 +116,54 @@ export class OsunyOwl {
 }
 
 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
      */
     
@@ -168,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",
@@ -177,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.
@@ -208,9 +247,9 @@ 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_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
@@ -265,11 +304,12 @@ export class OsunyUtility{
      * @param {string} migration_identifier (Required) A unique identifier to catch its migration in the logs 
      * @param {Array} blocks (Required) Array of the different Communication::Blocks composing the post 
      * @param {Array} category_ids (Optional) Array of strings representing the category or all the categories attached to this post. Empty Array by default
+     * @param {Date} crea_dt (Optional) Date of the post. Undefined by default
      * @param {boolean} full_width (Optional) Indicates if the article should take all the theme width. False by default
      * @param {string} summary (Optional) A short text that summerize the post. Empty string by default
      * @returns Osuny's Communication::Post object.
      */
-    static createPost(title, migration_identifier, blocks, category_ids = [], full_width=false, summary=""){
+    static createPost(title, migration_identifier, blocks, category_ids = [], crea_dt=undefined, full_width=false, summary=""){
         return {
             "id": undefined,
             "migration_identifier": migration_identifier,
@@ -283,11 +323,11 @@ export class OsunyUtility{
                     "featured_image": undefined,
                     "pinned": false,
                     "published": true,
-                    "published_at": undefined,
+                    "published_at": crea_dt,
                     "slug": this.slugify(title),
                     "summary": summary,
                     "blocks": blocks,
-                    "created_at": undefined
+                    "created_at": crea_dt
                 }
             }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osuny-owl",
-  "version": "1.0.1-alpha",
+  "version": "1.1.1",
   "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",