osuny-owl 1.1.0 → 2.0.0

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,21 @@
+# This workflow will publish a package to npm when a release is created
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/{index.js → index_old.js}

@@ -303,36 +303,65 @@ export class OsunyUtility{
      * @param {string} title (Required) Title of the article / post 
      * @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 {String} locale (Optional) Set the locale of the post created.  Set to "fr" by default
      * @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, locale = "fr", category_ids = [], crea_dt=undefined, full_width=false, summary=""){
         return {
             "id": undefined,
             "migration_identifier": migration_identifier,
             "full_width": full_width,
             "category_ids": category_ids,
             "localizations": {
-                "fr": {
+                [locale]: {
                     "id": undefined,
-                    "migration_identifier": migration_identifier + "_fr",
+                    "migration_identifier": migration_identifier + `_${locale}`,
                     "title": title,
                     "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
                 }
             }
 
         }
     }
 
+    static createProject(title, migration_identifier, year, blocks, locale="fr", category_ids = [], full_width=true, crea_dt=undefined, summary=""){
+        return {
+            "id": undefined,
+            "migration_identifier": migration_identifier,
+            "full_width": full_width,
+            "year": year,
+            "category_ids": category_ids,
+            "localizations": {
+                [locale]: {
+                    "id": undefined,
+                    "migration_identifier": migration_identifier + `_${locale}`,
+                    "title": title,
+                    "featured_image": undefined,
+                    "pinned": false,
+                    "published": true,
+                    "published_at": crea_dt,
+                    "slug": this.slugify(title),
+                    "summary": summary,
+                    "blocks": blocks,
+                    "created_at": crea_dt
+                }
+            }
+
+        }
+    }
+
+
     /**
      * 
      * @param  {...Object} osunyBlocks Osuny's Communication::Block in JSON.

package/package.json

@@ -1,20 +1,17 @@
 {
   "name": "osuny-owl",
-  "version": "1.1.0",
+  "version": "2.0.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",
-    "api"
-  ],
+  "keywords": ["osuny", "api"],
   "license": "GPL-3.0",
   "author": "Sacha André",
   "type": "module",
-  "main": "index.js",
+  "main": "src/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"No test for this package\" && exit 0"
   },
   "dependencies": {
     "dotenv": "^16.5.0",
     "node-fetch": "^3.3.2"
   }
-}
+}

package/readme.md

@@ -3,8 +3,6 @@
 Osuny Owl is a little package that adds a cute owl who can help you talk with an Osuny API.
 Still under construction, it's main use is for the creation of large sums of data, or for external apps that want to create posts in a static website. (With Peuplier for exemple)
 
->[!NOTE]
-> This package is for the moment usable only for websites localized in french.
 
 ## Adopt an owl
 
@@ -20,7 +18,7 @@ Here, `website_id` is the unique identifier of one of your websites and `api_url
 ## The OsunyUtility
 
 > [!NOTE]
-> The Utility is for the moment very limited. Images are not supported for the moment
+> The Utility is for the moment very limited. All the Blocks are not supported
 
 To use it in your app, you can import it like this
 
@@ -30,4 +28,4 @@ import { OsunyUtility } from 'osuny-owl';
 let chapterOne = OsunyUtility.createChapter(...)
 let datatableOne = OsunyUtility.createDatable(...)
 let postOne = OsunyUtility.createPost(...)
-```
+```

package/src/OsunyOwl.js

@@ -0,0 +1,63 @@
+import 'dotenv/config';
+import { apiPost } from './api/client.js';
+
+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) {
+    this._website_id = website_id;
+  }
+
+  set category_ids(category_ids) {
+    this._category_ids = category_ids;
+  }
+
+  checkApiKey() {
+    this.api_key_defined = process.env.OSUNY_API_KEY ? true : false;
+  }
+
+  get website_id() {
+    return this._website_id;
+  }
+
+  get category_ids() {
+    return this._category_ids;
+  }
+
+  addCategory_id(category_id) {
+    this.category_ids.push(category_id);
+  }
+
+  removeCategory_id(category_id) {
+    if (this.category_ids.includes(category_id)) {
+      this.category_ids = this.category_ids.filter(e => e !== category_id);
+    }
+  }
+
+  async postToOsuny(post) {
+    if (this.api_key_defined) {
+      const url = this.api_url + "/communication/websites/" + this.website_id + "/posts";
+      await apiPost(url, post, process.env.OSUNY_API_KEY, false);
+      return true;
+    } else {
+      throw new Error("No API Key Defined");
+    }
+  }
+
+  async importImage(img_bdy) {
+    if (this.api_key_defined) {
+      const url = this.api_url + "/communication/medias";
+      let dataR = await apiPost(url, img_bdy, process.env.OSUNY_API_KEY, true);
+      this.last_media = dataR.original_blob;
+      return true;
+    } else {
+      throw new Error("No API Key Defined");
+    }
+  }
+}

package/src/api/client.js

@@ -0,0 +1,28 @@
+import fetch from 'node-fetch';
+
+export async function apiPost(url, data, apiKey, isFormData = false) {
+  const headers = {
+    'X-Osuny-Token': apiKey
+  };
+
+  if (!isFormData) {
+    headers['Content-Type'] = 'application/json';
+  }
+
+  try {
+    const response = await fetch(url, {
+      method: 'POST',
+      headers,
+      body: isFormData ? data : JSON.stringify(data)
+    });
+
+    if (!response.ok) {
+      throw new Error(`Response status: ${response.status}`);
+    }
+
+    return await response.json();
+  } catch (error) {
+    console.error(error.message);
+    throw error;
+  }
+}

package/src/api/endpoint.js

@@ -0,0 +1,4 @@
+export const endpoints = {
+  posts: (websiteId) => `/communication/websites/${websiteId}/posts`,
+  media: () => '/communication/medias',
+};

package/src/builders/blocks/chapter.js

@@ -0,0 +1,32 @@
+export function createChapter(text, migration_identifier, position, title = "", layout = 1) {
+  let layout_text;
+
+  switch (layout) {
+    case 1:
+      layout_text = "no_background";
+      break;
+    case 2:
+      layout_text = "alt_background";
+      break;
+    case 3:
+      layout_text = "accent_background";
+      break;
+    default:
+      layout_text = "no_background";
+      break;
+  }
+
+  return {
+    "id": null,
+    "migration_identifier": migration_identifier,
+    "template_kind": "chapter",
+    "title": title,
+    "position": position,
+    "published": true,
+    "html_class": null,
+    "data": {
+      "layout": layout_text,
+      "text": text,
+    }
+  };
+}

package/src/builders/blocks/datatable.js

@@ -0,0 +1,17 @@
+export function createDatatable(table_data, table_headers = [], migration_identifier, position, title = "", alphabetical = false, caption = "") {
+  return {
+    "id": null,
+    "migration_identifier": migration_identifier,
+    "template_kind": "datatable",
+    "title": title,
+    "position": position,
+    "published": true,
+    "html_class": null,
+    "data": {
+      "columns": table_headers,
+      "elements": table_data,
+      "alphabetical": alphabetical,
+      "caption": caption
+    }
+  };
+}

package/src/builders/blocks/image.js

@@ -0,0 +1,21 @@
+export function 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
+    }
+  };
+}

package/src/builders/blocks/index.js

@@ -0,0 +1,5 @@
+export { createTitle } from './title.js';
+export { createChapter } from './chapter.js';
+export { createDatatable } from './datatable.js';
+export { createVideo } from './video.js';
+export { createImage } from './image.js';

package/src/builders/blocks/title.js

@@ -0,0 +1,28 @@
+export function 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
+    }
+  };
+}

package/src/builders/blocks/video.js

@@ -0,0 +1,18 @@
+export function 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
+    }
+  };
+}

package/src/builders/content.js

@@ -0,0 +1,58 @@
+import { slugify } from '../utils/slug.js';
+
+export function createPost(title, migration_identifier, blocks, locale = "fr", category_ids = [], crea_dt = undefined, full_width = false, summary = "") {
+  return {
+    "id": undefined,
+    "migration_identifier": migration_identifier,
+    "full_width": full_width,
+    "category_ids": category_ids,
+    "localizations": {
+      [locale]: {
+        "id": undefined,
+        "migration_identifier": migration_identifier + `_${locale}`,
+        "title": title,
+        "featured_image": undefined,
+        "pinned": false,
+        "published": true,
+        "published_at": crea_dt,
+        "slug": slugify(title),
+        "summary": summary,
+        "blocks": blocks,
+        "created_at": crea_dt
+      }
+    }
+  };
+}
+
+export function createProject(title, migration_identifier, year, blocks, locale = "fr", category_ids = [], full_width = true, crea_dt = undefined, summary = "") {
+  return {
+    "id": undefined,
+    "migration_identifier": migration_identifier,
+    "full_width": full_width,
+    "year": year,
+    "category_ids": category_ids,
+    "localizations": {
+      [locale]: {
+        "id": undefined,
+        "migration_identifier": migration_identifier + `_${locale}`,
+        "title": title,
+        "featured_image": undefined,
+        "pinned": false,
+        "published": true,
+        "published_at": crea_dt,
+        "slug": slugify(title),
+        "summary": summary,
+        "blocks": blocks,
+        "created_at": crea_dt
+      }
+    }
+  };
+}
+
+export function composePost(...osunyBlocks) {
+  let blocksArray = [];
+  osunyBlocks.forEach((el) => {
+    blocksArray.push(el);
+  });
+  return blocksArray;
+}

package/src/builders/index.js

@@ -0,0 +1,15 @@
+import * as blocks from './blocks/index.js';
+import { createPost, createProject, composePost } from './content.js';
+import { slugify } from '../utils/slug.js';
+
+export class OsunyUtility {
+  static createTitle = blocks.createTitle;
+  static createChapter = blocks.createChapter;
+  static createDatatable = blocks.createDatatable;
+  static createVideo = blocks.createVideo;
+  static createImage = blocks.createImage;
+  static createPost = createPost;
+  static createProject = createProject;
+  static composePost = composePost;
+  static slugify = slugify;
+}

package/src/index.js

@@ -0,0 +1,2 @@
+export { OsunyOwl } from './OsunyOwl.js';
+export { OsunyUtility } from './builders/index.js';

package/src/ressources/posts.js

@@ -0,0 +1,13 @@
+import { endpoints } from '../api/endpoints.js';
+
+export class PostsResource {
+  constructor(client, websiteId) {
+    this.client = client;
+    this.websiteId = websiteId;
+  }
+
+  async create(post) {
+    const endpoint = endpoints.posts(this.websiteId);
+    return this.client.post(endpoint, post);
+  }
+}

package/src/utils/slug.js

@@ -0,0 +1,9 @@
+export function slugify(str) {
+  // Code taken from: https://dev.to/bybydev/how-to-slugify-a-string-in-javascript-4o9n
+  str = str.replace(/^\s+|\s+$/g, ''); // trim leading/trailing white space
+  str = str.toLowerCase(); // convert string to lowercase
+  str = str.replace(/[^a-z0-9 -]/g, '') // remove any non-alphanumeric characters
+          .replace(/\s+/g, '-') // replace spaces with hyphens
+          .replace(/-+/g, '-'); // remove consecutive hyphens
+  return str;
+}