@d-najd/universal-media-tracker-sdk 0.0.9 → 0.1.0

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 import PluginConfig from "./types/pluginConfig";
-import CreateResourceHandler from "./types/handler/media/createResourceHandler";
 import CreateCatalogHandler from "./types/handler/media/catalog/createCatalogHandler";
+import CreateResourceHandler from "./types/handler/media/createResourceHandler";
+import CreatePluginSourceHandler from "./types/handler/plugin/source/createPluginSourceHandler";
+import CreateHandler from "./types/handler/base/createHandler";
+import CreatePluginFactoryHandler from "./types/handler/plugin/factory/createPluginFactoryHandler";
 export default class Plugin {
     readonly config: PluginConfig;
     private handlers;
@@ -12,6 +15,7 @@ export default class Plugin {
      */
     onLoad(callback: () => Promise<void>): void;
     onUnload(callback: () => Promise<void>): void;
+    defineHandler(handler: CreateHandler): string;
     /**
      * @see Handler
      */
@@ -22,6 +26,8 @@ export default class Plugin {
      * @see defineResourceHandler
      */
     defineCatalogHandler(handler: CreateCatalogHandler): string;
+    definePluginSourceHandler(handler: CreatePluginSourceHandler): string;
+    definePluginFactoryHandler(handler: CreatePluginFactoryHandler): string;
     private getSpec;
     private onLoadCallback;
     private onUnloadCallback;

package/dist/index.js

@@ -21,12 +21,20 @@ export default class Plugin {
             this.loaded = false;
         };
     }
+    defineHandler(handler) {
+        const newHandler = {
+            id: `${this.config.id}-custom-${this.counter++}`,
+            ...handler
+        };
+        this.handlers.set(newHandler.id, newHandler);
+        return newHandler.id;
+    }
     /**
      * @see Handler
      */
     defineResourceHandler(handler) {
         const newHandler = {
-            id: `${this.config.id}-custom-${this.counter++}`,
+            id: `${this.config.id}-custom-resource-${this.counter++}`,
             name: `${this.config.name}`,
             ...handler
         };
@@ -40,12 +48,29 @@ export default class Plugin {
      */
     defineCatalogHandler(handler) {
         const newHandler = {
-            id: `${this.config.id}-catalog-handler`,
+            id: `${this.config.id}-catalog`,
+            name: `${this.config.name}`,
             ...handler,
             type: 'catalog-request'
         };
         return this.defineResourceHandler(newHandler);
     }
+    definePluginSourceHandler(handler) {
+        const newHandler = {
+            id: `${this.config.id}-plugin-source`,
+            ...handler,
+            type: 'plugin-source'
+        };
+        return this.defineHandler(newHandler);
+    }
+    definePluginFactoryHandler(handler) {
+        const newHandler = {
+            id: `${this.config.id}-plugin-factory`,
+            ...handler,
+            type: 'plugin-factory'
+        };
+        return this.defineHandler(newHandler);
+    }
     // Used internally, private since its internal api
     // noinspection JSUnusedLocalSymbols
     getSpec() {

package/dist/types/handler/base/baseHandler.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Less strict version because helper scripts define default type and id
+ * @see Handler
+ */
+type BaseHandler<T = any, R = any> = {
+    id?: string;
+    type?: string;
+    callback: (args: T) => Promise<R>;
+};
+export default BaseHandler;

package/dist/types/handler/base/createHandler.d.ts

@@ -0,0 +1,5 @@
+import BaseHandler from "./baseHandler";
+type CreateHandler<T = any, R = any> = BaseHandler<T, R> & {
+    type: string;
+};
+export default CreateHandler;

package/dist/types/handler/base/createHandler.js

@@ -0,0 +1 @@
+export {};

package/dist/types/handler/base/handler.d.ts

@@ -1,6 +1,8 @@
-type Handler<T = any, R = any> = {
+import BaseHandler from "./baseHandler";
+import HandlerTypes from "./handlerTypes";
+type Handler<T = any, R = any> = BaseHandler<T, R> & {
     id: string;
-    type: string;
+    type: HandlerTypes | string;
     callback: (args: T) => Promise<R>;
 };
 export default Handler;

package/dist/types/handler/base/handler.js

@@ -8,5 +8,6 @@
  *   id exists, it will be overridden.
  * - `name` name of the handler that will be displayed in the app
  * - `callback` callback function that is called when the handler is invoked
+ * @see BaseHandler
  */
 export {};

package/dist/types/handler/base/handlerTypes.d.ts

@@ -0,0 +1,2 @@
+type ResourceHandlerType = 'catalog-request' | 'plugin-source' | 'plugin-factory';
+export default ResourceHandlerType;

package/dist/types/handler/base/handlerTypes.js

@@ -0,0 +1 @@
+export {};

package/dist/types/handler/media/baseResourceHandler.d.ts

@@ -0,0 +1,9 @@
+import BaseHandlerArgs from "../base/baseHandlerArgs";
+import BaseHandlerResponse from "../base/baseHandlerResponse";
+import ResourceType from "./resourceType";
+import BaseHandler from "../base/baseHandler";
+type BaseResourceHandler<T extends BaseHandlerArgs = BaseHandlerArgs, R extends BaseHandlerResponse = BaseHandlerResponse> = BaseHandler<T, R> & {
+    name?: string;
+    resourceType?: ResourceType | string;
+};
+export default BaseResourceHandler;

package/dist/types/handler/media/baseResourceHandler.js

@@ -0,0 +1 @@
+export {};

package/dist/types/handler/media/catalog/createCatalogHandler.d.ts

@@ -1,8 +1,8 @@
-import CreateResourceHandler from "../createResourceHandler";
+import BaseResourceHandler from "../baseResourceHandler";
 import CatalogHandlerArgs from "./catalogHandlerArgs";
 import CatalogHandlerResponse from "./catalogHandlerResponse";
-import ResourceHandlerType from "../resourceHandlerType";
-type CreateCatalogHandler = Omit<CreateResourceHandler<CatalogHandlerArgs, CatalogHandlerResponse>, 'type'> & {
-    type?: ResourceHandlerType | string;
+import ResourceType from "../resourceType";
+type CreateCatalogHandler = BaseResourceHandler<CatalogHandlerArgs, CatalogHandlerResponse> & {
+    resourceType: ResourceType | string;
 };
 export default CreateCatalogHandler;

package/dist/types/handler/media/createResourceHandler.d.ts

@@ -1,8 +1,10 @@
 import BaseHandlerArgs from "../base/baseHandlerArgs";
 import BaseHandlerResponse from "../base/baseHandlerResponse";
-import ResourceHandler from "./resourceHandler";
-type CreateResourceHandler<T extends BaseHandlerArgs = BaseHandlerArgs, R extends BaseHandlerResponse = BaseHandlerResponse> = Omit<ResourceHandler<T, R>, 'id' | 'name'> & {
-    id?: string;
-    name?: string;
+import BaseResourceHandler from "./baseResourceHandler";
+import ResourceType from "./resourceType";
+import HandlerTypes from "../base/handlerTypes";
+type CreateResourceHandler<T extends BaseHandlerArgs = BaseHandlerArgs, R extends BaseHandlerResponse = BaseHandlerResponse> = BaseResourceHandler<T, R> & {
+    type: HandlerTypes | string;
+    resourceType: ResourceType | string;
 };
 export default CreateResourceHandler;

package/dist/types/handler/media/resourceHandler.d.ts

@@ -1,14 +1,15 @@
 import BaseHandlerArgs from "../base/baseHandlerArgs";
 import BaseHandlerResponse from "../base/baseHandlerResponse";
-import Handler from "../base/handler";
-import ResourceHandlerType from "./resourceHandlerType";
 import ResourceType from "./resourceType";
-type ResourceHandler<T extends BaseHandlerArgs = BaseHandlerArgs, R extends BaseHandlerResponse = BaseHandlerResponse> = Handler<T, R> & {
+import BaseResourceHandler from "./baseResourceHandler";
+import Handler from "../base/handler";
+import HandlerTypes from "../base/handlerTypes";
+type ResourceHandler<T extends BaseHandlerArgs = BaseHandlerArgs, R extends BaseHandlerResponse = BaseHandlerResponse> = BaseResourceHandler<T, R> & Handler<T, R> & {
     /**
      * Displayed in the app
      */
     name: string;
-    type: ResourceHandlerType | string;
+    type: HandlerTypes | string;
     resourceType: ResourceType | string;
 };
 export default ResourceHandler;

package/dist/types/handler/plugin/factory/createPluginFactoryHandler.d.ts

@@ -0,0 +1,4 @@
+import BaseHandler from "../../base/baseHandler";
+import PluginSourceHandlerResponse from "../source/pluginSourceHandlerResponse";
+type CreatePluginFactoryHandler = BaseHandler<PluginSourceHandlerArgs, PluginSourceHandlerResponse> & {};
+export default CreatePluginFactoryHandler;

package/dist/types/handler/plugin/factory/createPluginFactoryHandler.js

@@ -0,0 +1 @@
+export {};

package/dist/types/handler/plugin/factory/pluginFactoryHandlerArgs.d.ts

@@ -0,0 +1,3 @@
+type PluginFactoryHandlerArgs = {
+    uri: string;
+};

package/dist/types/handler/plugin/factory/pluginFactoryHandlerArgs.js

@@ -0,0 +1 @@
+"use strict";

package/dist/types/handler/plugin/factory/pluginFactoryHandlerResponse.d.ts

@@ -0,0 +1,12 @@
+import Plugin from '../../../../index';
+export type PluginFactoryHandlerResponse = {
+    readonly status: 'valid';
+    readonly plugin: Plugin;
+} | {
+    readonly status: 'skip';
+    readonly reason?: string;
+} | {
+    readonly status: 'invalid';
+    readonly reason: string;
+};
+export default PluginFactoryHandlerResponse;

package/dist/types/handler/plugin/factory/pluginFactoryHandlerResponse.js

@@ -0,0 +1 @@
+export {};

package/dist/types/handler/plugin/source/createPluginSourceHandler.d.ts

@@ -0,0 +1,4 @@
+import PluginSourceHandlerResponse from "./pluginSourceHandlerResponse";
+import BaseHandler from "../../base/baseHandler";
+type CreatePluginSourceHandler = BaseHandler<PluginSourceHandlerArgs, PluginSourceHandlerResponse> & {};
+export default CreatePluginSourceHandler;

package/dist/types/handler/plugin/source/createPluginSourceHandler.js

@@ -0,0 +1 @@
+export {};

package/dist/types/handler/plugin/source/pluginSourceHandlerArgs.d.ts

@@ -0,0 +1,3 @@
+type PluginSourceHandlerArgs = {
+    uri: string;
+};

package/dist/types/handler/plugin/source/pluginSourceHandlerArgs.js

@@ -0,0 +1 @@
+"use strict";

package/dist/types/handler/plugin/source/pluginSourceHandlerResponse.d.ts

@@ -0,0 +1,11 @@
+export type PluginSourceHandlerResponse = {
+    readonly status: 'valid';
+    readonly code: string;
+} | {
+    readonly status: 'skip';
+    readonly reason?: string;
+} | {
+    readonly status: 'invalid';
+    readonly reason: string;
+};
+export default PluginSourceHandlerResponse;

package/dist/types/handler/plugin/source/pluginSourceHandlerResponse.js

@@ -0,0 +1 @@
+export {};

package/package.json

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

package/dist/types/handler/media/resourceHandlerType.d.ts

@@ -1,2 +0,0 @@
-type ResourceHandlerType = 'catalog-request';
-export default ResourceHandlerType;