notes-to-strapi-export-article-ai 1.0.11 → 1.0.13

package/.github/workflows/deploy.yml

@@ -1,59 +1,93 @@
-name: Auto Deploy, install dependencies, increment version and push tag
+name: Auto Deploy, install dependencies, increment version, push tag, and create release
 
 on:
-    pull_request:
-        branches: [ main ]
-        types: [ closed ]
+  pull_request:
+    branches: [ main ]
+    types: [ closed ]
 
 jobs:
-    publish:
-        if: github.event.pull_request.merged == true
-        runs-on: ubuntu-latest
-        steps:
-            -   name: Checkout
-                uses: actions/checkout@v4
-                with:
-                    fetch-depth: 0
-                    token: ${{ secrets.GIT_TOKEN }}
-                    ref: 'main'
-
-            -   name: Configure Git
-                run: |
-                    git config --local user.email "cinquin.andy@gmail.com"
-                    git config --local user.name "CINQUIN Andy"
-
-            -   name: Use Node.js
-                uses: actions/setup-node@v4
-                with:
-                    node-version: '20'
-                    registry-url: 'https://registry.npmjs.org'
-
-            -   name: Install Dependencies
-                run: npm ci
-
-            -   name: Increment Package Version and Update Tag
-                id: version-bump
-                run: |
-                    git fetch --tags
-                    current_version=$(npm pkg get version | sed 's/"//g')
-                    echo "Current version: $current_version"
-                    
-                    new_version=$(npx semver -i patch $current_version)
-                    echo "New version: $new_version"
-                    
-                    while git rev-parse $new_version >/dev/null 2>&1; do
-                      new_version=$(npx semver -i patch $new_version)
-                      echo "Tag $new_version already exists. Trying next version..."
-                    done
-                    
-                    npm version $new_version --no-git-tag-version
-                    sed -i "s/\"version\": \".*\"/\"version\": \"$new_version\"/" manifest.json
-                    echo "version=$new_version" >> $GITHUB_OUTPUT
-
-            -   name: Commit and Push Version Update
-                run: |
-                    git add package.json manifest.json
-                    git commit -m "chore(release): ${{ steps.version-bump.outputs.version }}"
-                    git tag ${{ steps.version-bump.outputs.version }}
-                    git push origin main --follow-tags
-                    git push origin refs/tags/${{ steps.version-bump.outputs.version }}
+  publish:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GIT_TOKEN }}
+          ref: 'main'
+
+      - name: Configure Git
+        run: |
+          git config --local user.email "cinquin.andy@gmail.com"
+          git config --local user.name "CINQUIN Andy"
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Build TypeScript
+        run: npm run build
+
+      - name: Increment Package Version and Update Tag
+        id: version-bump
+        run: |
+          git fetch --tags
+          current_version=$(npm pkg get version | sed 's/"//g')
+          echo "Current version: $current_version"
+          
+          new_version=$(npx semver -i patch $current_version)
+          echo "New version: $new_version"
+          
+          while git rev-parse $new_version >/dev/null 2>&1; do
+            new_version=$(npx semver -i patch $new_version)
+            echo "Tag $new_version already exists. Trying next version..."
+          done
+          
+          npm version $new_version --no-git-tag-version
+          sed -i "s/\"version\": \".*\"/\"version\": \"$new_version\"/" manifest.json
+          echo "version=$new_version" >> $GITHUB_OUTPUT
+
+      - name: Commit and Push Version Update
+        run: |
+          git add package.json manifest.json
+          git commit -m "chore(release): ${{ steps.version-bump.outputs.version }}"
+          git tag ${{ steps.version-bump.outputs.version }}
+          git push origin main --follow-tags
+          git push origin refs/tags/${{ steps.version-bump.outputs.version }}
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GIT_TOKEN: ${{ secrets.GIT_TOKEN }}
+        with:
+          tag_name: ${{ steps.version-bump.outputs.version }}
+          release_name: Release ${{ steps.version-bump.outputs.version }}
+          draft: false
+          prerelease: false
+
+      - name: Upload main.js to Release
+        uses: actions/upload-release-asset@v1
+        env:
+          GIT_TOKEN: ${{ secrets.GIT_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./main.js
+          asset_name: main.js
+          asset_content_type: application/javascript
+
+      - name: Upload manifest.json to Release
+        uses: actions/upload-release-asset@v1
+        env:
+          GIT_TOKEN: ${{ secrets.GIT_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./manifest.json
+          asset_name: manifest.json
+          asset_content_type: application/json

package/README.md

@@ -43,29 +43,29 @@ To install Strapi Exporter, follow these steps (coming soon to the Obsidian plug
 To get started with Strapi Exporter, you'll need to configure the following settings:
 
 - **Strapi URL**: The URL of your Strapi instance (e.g., `https://your-strapi-url`).
-![img.png](img.png)
+![img.png](images/img.png)
 - **Strapi API Token**: Your Strapi API token for authentication. You can create an API token in your Strapi admin panel under "Settings" > "API Tokens".
-![img_1.png](img_1.png)
-![img_2.png](img_2.png)
+![img_1.png](images/img_1.png)
+![img_2.png](images/img_2.png)
 - You need, at least, to have the following permissions:
   - article: create
   - upload: create
   - (you can also add full permissions, but it's not really recommended for security reasons)
-![img_3.png](img_3.png)
+![img_3.png](images/img_3.png)
   - (the token in the screenshot is not valid, don't try to use it 😌)
 - **OpenAI API Key**: Your OpenAI API key for using GPT-3 to generate SEO-friendly content. You can get your API key from the [OpenAI website](https://platform.openai.com/account/api-keys).
-![img_4.png](img_4.png)
+![img_4.png](images/img_4.png)
   - this key is needed to use the GPT-3 API, which is used to generate the content of the article
   - (it need to access to "Model capabilities" with "write" permission)
-![img_5.png](img_5.png)
+![img_5.png](images/img_5.png)
   - (or with the "all" permission)
 - **JSON Template**: The JSON template for the article fields in Strapi. Customize this according to your Strapi content type structure. You can find the JSON template in your Strapi API documentation (Swagger).
-![img_6.png](img_6.png)
+![img_6.png](images/img_6.png)
   - to get the JSON template, you can go to the documentation of your Strapi API, and copy the JSON template of the article creation
   - it should look like this: ``https://{api_url}/documentation/v1.0.0``
   - then, go to the article creation, and copy the JSON template
-![img_7.png](img_7.png)
-![img_8.png](img_8.png)
+![img_7.png](images/img_7.png)
+![img_8.png](images/img_8.png)
   - it should look like this for example:
 ```json
 {
@@ -147,7 +147,7 @@ To get started with Strapi Exporter, you'll need to configure the following sett
 
 1. Open a Markdown file in Obsidian.
 2. Click on the plugin's ribbon icon to start the magic.
-![img_9.png](img_9.png)
+![img_9.png](images/img_9.png)
 3. Sit back and relax while Strapi Exporter does the heavy lifting:
     - 🖼️ Extracting and uploading images to Strapi
     - 🎨 Generating SEO-friendly alt text and captions for images

package/esbuild.config.mjs

@@ -15,7 +15,7 @@ const context = await esbuild.context({
 	banner: {
 		js: banner,
 	},
-	entryPoints: ["main.ts"],
+	entryPoints: ["src/main.ts"],
 	bundle: true,
 	external: [
 		"obsidian",

package/manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "notes-to-strapi-export-article-ai",
 	"name": "Strapi Exporter, Notes to Strapi article AI enhanced",
-	"version": "1.0.11",
+	"version": "1.0.13",
 	"minAppVersion": "1.5.0",
 	"description": "Effortlessly export your notes to Strapi CMS with AI-powered image handling and SEO optimization. Replace all the images in your notes by uploaded images in Strapi, and add SEO metadata to uploaded images.",
 	"author": "Cinquin Andy",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "notes-to-strapi-export-article-ai",
-	"version": "1.0.11",
+	"version": "1.0.13",
 	"description": "Effortlessly export your Obsidian notes to Strapi CMS with AI-powered image handling and SEO optimization. Replace all the images in your notes by uploaded images in Strapi, and add SEO metadata to uploaded images.",
 	"main": "main.js",
 	"scripts": {
@@ -22,6 +22,7 @@
 		"typescript": "5.4.3"
 	},
 	"dependencies": {
-		"openai": "^4.0.0"
+		"openai": "^4.0.0",
+		"process": "^0.11.10"
 	}
 }

package/src/constants.ts

@@ -0,0 +1,67 @@
+import { StrapiExporterSettings } from './types/settings'
+
+/**
+ * The default settings for the plugin
+ */
+export const DEFAULT_STRAPI_EXPORTER_SETTINGS: StrapiExporterSettings = {
+	strapiUrl: '',
+	strapiApiToken: '',
+	openaiApiKey: '',
+	jsonTemplate: `{
+    "data": {
+      "title": "string",
+      "seo_title": "string",
+      "seo_description": "string",
+      "slug": "string",
+      "excerpt": "string",
+      "links": [
+        {
+          "id": "number",
+          "label": "string",
+          "url": "string"
+        }
+      ],
+      "subtitle": "string",
+      "type": "string",
+      "rank": "number",
+      "tags": [
+        {
+          "id": "number",
+          "name": "string"
+        }
+      ],
+      "locale": "string"
+    }
+  }`,
+	jsonTemplateDescription: `{
+    "data": {
+      "title": "Title of the item, as a short string",
+      "seo_title": "SEO optimized title, as a short string",
+      "seo_description": "SEO optimized description, as a short string",
+      "slug": "URL-friendly string derived from the title",
+      "excerpt": "A short preview or snippet from the content",
+      "links": "Array of related links with ID, label, and URL",
+      "subtitle": "Subtitle or secondary title, as a short string",
+      "type": "Category or type of the item, as a short string",
+      "rank": "Numerical ranking or order priority, as a number",
+      "tags": "Array of associated tags with ID and name",
+      "locale": "Locale or language code, as a short string"
+    }
+  }`,
+	strapiArticleCreateUrl: '',
+	strapiContentAttributeName: '',
+	additionalPrompt: '',
+	enableAdditionalApiCall: false,
+	additionalJsonTemplate: '',
+	additionalJsonTemplateDescription: '',
+	additionalUrl: '',
+	additionalContentAttributeName: '',
+	mainButtonImageEnabled: false,
+	mainButtonGalleryEnabled: false,
+	additionalButtonImageEnabled: false,
+	additionalButtonGalleryEnabled: false,
+	mainImageFullPathProperty: '',
+	mainGalleryFullPathProperty: '',
+	additionalImageFullPathProperty: '',
+	additionalGalleryFullPathProperty: '',
+}

package/src/main.ts

@@ -0,0 +1,61 @@
+import { Plugin } from 'obsidian'
+import { StrapiExporterSettingTab } from './settings'
+import { DEFAULT_STRAPI_EXPORTER_SETTINGS } from './constants'
+import { processMarkdownContent } from './utils/image-processor'
+import { StrapiExporterSettings } from './types/settings'
+
+export default class StrapiExporterPlugin extends Plugin {
+	settings: StrapiExporterSettings
+
+	async onload() {
+		await this.loadSettings()
+
+		// Add ribbon icons and event listeners
+		/**
+		 * Add a ribbon icon to the Markdown view (the little icon on the left side bar)
+		 */
+		const ribbonIconEl = this.addRibbonIcon(
+			'upload',
+			'Upload images to Strapi and update links in Markdown content, then generate article content using OpenAI',
+			async (evt: MouseEvent) => {
+				await this.processMarkdownContent()
+			}
+		)
+		ribbonIconEl.addClass('strapi-exporter-ribbon-class')
+
+		/**
+		 * Add a ribbon icon based on the settings (if enabled)
+		 */
+		if (this.settings.enableAdditionalApiCall) {
+			const additionalRibbonIconEl = this.addRibbonIcon(
+				'link',
+				'Upload images to Strapi and update links in Markdown content, then generate additional content using OpenAI',
+				async (evt: MouseEvent) => {
+					await this.processMarkdownContent(true)
+				}
+			)
+			additionalRibbonIconEl.addClass('strapi-exporter-additional-ribbon-class')
+		}
+
+		this.addSettingTab(new StrapiExporterSettingTab(this.app, this))
+	}
+
+	onunload() {}
+
+	async loadSettings() {
+		this.settings = Object.assign(
+			{},
+			DEFAULT_STRAPI_EXPORTER_SETTINGS,
+			await this.loadData()
+		)
+	}
+
+	async saveSettings() {
+		await this.saveData(this.settings)
+	}
+
+	async processMarkdownContent(useAdditionalCallAPI = false) {
+		// Call processMarkdownContent from image-processor.ts
+		await processMarkdownContent(this.app, this.settings, useAdditionalCallAPI)
+	}
+}