@d-najd/universal-media-tracker-sdk 0.1.6 → 0.1.7

package/dist/Plugin.d.ts

@@ -14,9 +14,12 @@ export default class Plugin {
     private loaded;
     constructor(options: PluginConfig);
     /**
-     * Don't define handlers here, they are part of the spec
+     * Called when plugin is loaded
      */
     onLoad(callback: () => Promise<void>): void;
+    /**
+     * Called when plugin is unloaded
+     */
     onUnload(callback: () => Promise<void>): void;
     defineHandler(handler: CreateHandler): string;
     /**
@@ -25,11 +28,17 @@ export default class Plugin {
     defineResourceHandler(handler: CreateResourceHandler): string;
     /**
      * Defines or overrides if a catalog handler has already been defined, if
-     * you use multiple catalog handlers use `defineMediaHandler` instead
+     * you use multiple catalog handlers use `defineResourceHandler` instead
      * @see defineResourceHandler
      */
     defineCatalogHandler(handler: CreateCatalogHandler): string;
+    /**
+     * Defined or overrides the handler if already defined, if you need multiple handers use `defineHandler` instead
+     */
     definePluginSourceHandler(handler: CreatePluginSourceHandler): string;
+    /**
+     * Defined or overrides the handler if already defined, if you need multiple handers use `defineHandler` instead
+     */
     definePluginFactoryHandler(handler: CreatePluginFactoryHandler): string;
     private getSpec;
     private onLoadCallback;

package/dist/Plugin.js

@@ -10,7 +10,7 @@ export default class Plugin {
         this.config = options;
     }
     /**
-     * Don't define handlers here, they are part of the spec
+     * Called when plugin is loaded
      */
     onLoad(callback) {
         this.onLoadCallback = async () => {
@@ -18,6 +18,9 @@ export default class Plugin {
             this.loaded = true;
         };
     }
+    /**
+     * Called when plugin is unloaded
+     */
     onUnload(callback) {
         this.onUnloadCallback = async () => {
             await callback();
@@ -46,7 +49,7 @@ export default class Plugin {
     }
     /**
      * Defines or overrides if a catalog handler has already been defined, if
-     * you use multiple catalog handlers use `defineMediaHandler` instead
+     * you use multiple catalog handlers use `defineResourceHandler` instead
      * @see defineResourceHandler
      */
     defineCatalogHandler(handler) {
@@ -58,6 +61,9 @@ export default class Plugin {
         };
         return this.defineResourceHandler(newHandler);
     }
+    /**
+     * Defined or overrides the handler if already defined, if you need multiple handers use `defineHandler` instead
+     */
     definePluginSourceHandler(handler) {
         const newHandler = {
             id: `${this.config.id}-plugin-source`,
@@ -66,6 +72,9 @@ export default class Plugin {
         };
         return this.defineHandler(newHandler);
     }
+    /**
+     * Defined or overrides the handler if already defined, if you need multiple handers use `defineHandler` instead
+     */
     definePluginFactoryHandler(handler) {
         const newHandler = {
             id: `${this.config.id}-plugin-factory`,
@@ -74,11 +83,10 @@ export default class Plugin {
         };
         return this.defineHandler(newHandler);
     }
-    // Used internally, private since its internal api
-    // noinspection JSUnusedLocalSymbols
-    getSpec() {
+    // Used internally
+    async getSpec() {
         if (!this.loaded) {
-            throw Error("The plugin must be loaded before getting it's spec");
+            await this.onLoadCallback();
         }
         return {
             config: this.config,

package/dist/index.d.ts

@@ -11,13 +11,13 @@ export { default as CreateHandler } from './types/handler/base/CreateHandler';
 export { default as BaseHandlerResponse } from './types/handler/base/BaseHandlerResponse';
 export { default as BaseHandlerArgs } from './types/handler/base/BaseHandlerArgs';
 export { default as BaseHandler } from './types/handler/base/BaseHandler';
-export { default as MetaPreview } from './types/handler/media/catalog/MetaPreview';
-export { default as CreateCatalogHandler } from './types/handler/media/catalog/CreateCatalogHandler';
-export { default as CatalogHandlerResponse } from './types/handler/media/catalog/CatalogHandlerResponse';
-export { default as CatalogHandlerArgs } from './types/handler/media/catalog/CatalogHandlerArgs';
 export { default as PluginSourceHandlerResponse } from './types/handler/plugin/source/PluginSourceHandlerResponse';
 export { default as PluginSourceHandlerArgs } from './types/handler/plugin/source/PluginSourceHandlerArgs';
 export { default as CreatePluginSourceHandler } from './types/handler/plugin/source/CreatePluginSourceHandler';
 export { default as PluginFactoryHandlerResponse } from './types/handler/plugin/factory/PluginFactoryHandlerResponse';
 export { default as PluginFactoryHandlerArgs } from './types/handler/plugin/factory/PluginFactoryHandlerArgs';
 export { default as CreatePluginFactoryHandler } from './types/handler/plugin/factory/CreatePluginFactoryHandler';
+export { default as MetaPreview } from './types/handler/media/catalog/MetaPreview';
+export { default as CreateCatalogHandler } from './types/handler/media/catalog/CreateCatalogHandler';
+export { default as CatalogHandlerResponse } from './types/handler/media/catalog/CatalogHandlerResponse';
+export { default as CatalogHandlerArgs } from './types/handler/media/catalog/CatalogHandlerArgs';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@d-najd/universal-media-tracker-sdk",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [