feat: add first custom api usage

Author: FlorianWoelki

src/@types/obsidian.d.ts

@@ -1,3 +1,4 @@
+import IconizeAPI from '@app/lib/api';
 import {
   Editor,
   TAbstractFile,
@@ -67,6 +68,14 @@ declare module 'obsidian' {
   }
 
   interface App {
+    plugins: {
+      enabledPlugins: Set<string>;
+      plugins: {
+        ['obsidian-icon-folder']?: {
+          api: IconizeAPI;
+        };
+      };
+    };
     internalPlugins: {
       plugins: InternalPlugins;
       getPluginById<T extends keyof InternalPlugins>(id: T): InternalPlugins[T];

src/index.ts

@@ -0,0 +1,6 @@
+import IconizeAPI from './lib/api';
+import IconizePlugin from './main';
+
+export function getApi(plugin: IconizePlugin): IconizeAPI | undefined {
+  return plugin.app.plugins.plugins['obsidian-icon-folder']?.api;
+}

src/lib/api.ts

@@ -0,0 +1,19 @@
+import IconizePlugin from '@app/main';
+
+export { AllIconsLoadedEvent } from '@lib/event/events';
+
+export default interface IconizeAPI {
+  version: {
+    current: string;
+  };
+}
+
+export function getApi(plugin: IconizePlugin): IconizeAPI {
+  return {
+    version: {
+      get current() {
+        return plugin.manifest.version;
+      },
+    },
+  };
+}

src/main.ts

@@ -62,6 +62,7 @@ import {
 import ChangeColorModal from './ui/change-color-modal';
 import { logger } from './lib/logger';
 import { EventEmitter } from './lib/event/event';
+import { getApi } from './lib/api';
 
 export interface FolderIconObject {
   iconName: string | null;
@@ -80,9 +81,10 @@ export default class IconizePlugin extends Plugin {
   public positionField: PositionField = buildPositionField(this);
 
   private frontmatterCache = new Set<string>();
-
   private eventEmitter = new EventEmitter();
 
+  public readonly api = getApi(this);
+
   async onload() {
     console.log(`loading ${config.PLUGIN_NAME}`);