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

package/dist/index.d.ts

@@ -1,59 +1,10 @@
-type PluginConfig = {
-    readonly id: string;
-    readonly name: string;
-    readonly version: string;
-};
-
-type BaseHandlerArgs = {
-    readonly search?: string;
-    readonly skip?: number;
-    readonly pageSize?: number;
-};
-
-type BaseHandlerResponse<T = any> = {
-    readonly data: T[];
-};
-
-type Handler<T = any, R = any> = {
-    id: string;
-    type: string;
-    callback: (args: T) => Promise<R>;
-};
-
-type ResourceHandlerType = 'catalog-request';
-
-type ResourceType = 'movie' | 'series';
-
-type ResourceHandler<T extends BaseHandlerArgs = BaseHandlerArgs, R extends BaseHandlerResponse = BaseHandlerResponse> = Handler<T, R> & {
-    /**
-     * Displayed in the app
-     */
-    name: string;
-    type: ResourceHandlerType | string;
-    resourceType: ResourceType | string;
-};
-
-type CreateResourceHandler<T extends BaseHandlerArgs = BaseHandlerArgs, R extends BaseHandlerResponse = BaseHandlerResponse> = Omit<ResourceHandler<T, R>, 'id' | 'name'> & {
-    id?: string;
-    name?: string;
-};
-
-type CatalogHandlerArgs = BaseHandlerArgs & {};
-
-type MetaPreview = {
-    readonly id: string;
-    readonly type: string;
-    readonly name: string;
-    readonly poster: string;
-};
-
-type CatalogHandlerResponse = BaseHandlerResponse<MetaPreview> & {};
-
-type CreateCatalogHandler = Omit<CreateResourceHandler<CatalogHandlerArgs, CatalogHandlerResponse>, 'type'> & {
-    type?: ResourceHandlerType | string;
-};
-
-declare class Plugin {
+import PluginConfig from "./types/pluginConfig";
+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;
     private counter;
@@ -64,6 +15,7 @@ declare class Plugin {
      */
     onLoad(callback: () => Promise<void>): void;
     onUnload(callback: () => Promise<void>): void;
+    defineHandler(handler: CreateHandler): string;
     /**
      * @see Handler
      */
@@ -74,9 +26,9 @@ declare class Plugin {
      * @see defineResourceHandler
      */
     defineCatalogHandler(handler: CreateCatalogHandler): string;
+    definePluginSourceHandler(handler: CreatePluginSourceHandler): string;
+    definePluginFactoryHandler(handler: CreatePluginFactoryHandler): string;
     private getSpec;
     private onLoadCallback;
     private onUnloadCallback;
 }
-
-export { Plugin as default };

package/dist/index.js

@@ -1,72 +1,93 @@
-// src/index.ts
-var Plugin = class {
-  config;
-  handlers = /* @__PURE__ */ new Map();
-  counter = 0;
-  loaded = false;
-  constructor(options) {
-    this.config = options;
-  }
-  /**
-   * Don't define handlers here, they are part of the spec
-   */
-  onLoad(callback) {
-    this.onLoadCallback = async () => {
-      await callback();
-      this.loaded = true;
-    };
-  }
-  onUnload(callback) {
-    this.onUnloadCallback = async () => {
-      await callback();
-      this.loaded = false;
-    };
-  }
-  /**
-   * @see Handler
-   */
-  defineResourceHandler(handler) {
-    const newHandler = {
-      id: `${this.config.id}-custom-${this.counter++}`,
-      name: `${this.config.name}`,
-      ...handler
-    };
-    this.handlers.set(newHandler.id, newHandler);
-    return newHandler.id;
-  }
-  /**
-   * Defines or overrides if a catalog handler has already been defined, if
-   * you use multiple catalog handlers use `defineMediaHandler` instead
-   * @see defineResourceHandler
-   */
-  defineCatalogHandler(handler) {
-    const newHandler = {
-      id: `${this.config.id}-catalog-handler`,
-      ...handler,
-      type: "catalog-request"
-    };
-    return this.defineResourceHandler(newHandler);
-  }
-  // Used internally, private since its internal api
-  // noinspection JSUnusedLocalSymbols
-  getSpec() {
-    if (!this.loaded) {
-      throw Error("The plugin must be loaded before getting it's spec");
+export default class Plugin {
+    config;
+    handlers = new Map();
+    counter = 0;
+    loaded = false;
+    constructor(options) {
+        this.config = options;
+    }
+    /**
+     * Don't define handlers here, they are part of the spec
+     */
+    onLoad(callback) {
+        this.onLoadCallback = async () => {
+            await callback();
+            this.loaded = true;
+        };
+    }
+    onUnload(callback) {
+        this.onUnloadCallback = async () => {
+            await callback();
+            this.loaded = false;
+        };
+    }
+    defineHandler(handler) {
+        const newHandler = {
+            id: `${this.config.id}-custom-${this.counter++}`,
+            ...handler
+        };
+        this.handlers.set(newHandler.id, newHandler);
+        return newHandler.id;
     }
-    return {
-      config: this.config,
-      handlers: this.handlers,
-      onLoad: this.onLoadCallback,
-      onUnload: this.onUnloadCallback
+    /**
+     * @see Handler
+     */
+    defineResourceHandler(handler) {
+        const newHandler = {
+            id: `${this.config.id}-custom-resource-${this.counter++}`,
+            name: `${this.config.name}`,
+            ...handler
+        };
+        this.handlers.set(newHandler.id, newHandler);
+        return newHandler.id;
+    }
+    /**
+     * Defines or overrides if a catalog handler has already been defined, if
+     * you use multiple catalog handlers use `defineMediaHandler` instead
+     * @see defineResourceHandler
+     */
+    defineCatalogHandler(handler) {
+        const newHandler = {
+            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() {
+        if (!this.loaded) {
+            throw Error("The plugin must be loaded before getting it's spec");
+        }
+        return {
+            config: this.config,
+            handlers: this.handlers,
+            onLoad: this.onLoadCallback,
+            onUnload: this.onUnloadCallback
+        };
+    }
+    onLoadCallback = async () => {
+        this.loaded = true;
+    };
+    onUnloadCallback = async () => {
+        this.loaded = false;
     };
-  }
-  onLoadCallback = async () => {
-    this.loaded = true;
-  };
-  onUnloadCallback = async () => {
-    this.loaded = false;
-  };
-};
-export {
-  Plugin as default
-};
+}

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/baseHandler.js

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

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

@@ -0,0 +1,6 @@
+type BaseHandlerArgs = {
+    readonly search?: string;
+    readonly skip?: number;
+    readonly pageSize?: number;
+};
+export default BaseHandlerArgs;

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

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

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

@@ -0,0 +1,4 @@
+type BaseHandlerResponse<T = any> = {
+    readonly data: T[];
+};
+export default BaseHandlerResponse;

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

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

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

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

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

@@ -0,0 +1,13 @@
+/*
+ * Represents a plugin handler.
+ *
+ * @remarks
+ * - `type` can be a predefined `MediaHandlerTypes` value or any custom string.
+ *   Custom types must be handled by the plugin author.
+ * - `id` is a unique identifier for the handler. If a handler with the same
+ *   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/catalogHandlerArgs.d.ts

@@ -0,0 +1,3 @@
+import BaseHandlerArgs from "../../base/baseHandlerArgs";
+type CatalogHandlerArgs = BaseHandlerArgs & {};
+export default CatalogHandlerArgs;

package/dist/types/handler/media/catalog/catalogHandlerArgs.js

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

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

@@ -0,0 +1,4 @@
+import BaseHandlerResponse from "../../base/baseHandlerResponse";
+import MetaPreview from "./metaPreview";
+type CatalogHandlerResponse = BaseHandlerResponse<MetaPreview> & {};
+export default CatalogHandlerResponse;

package/dist/types/handler/media/catalog/catalogHandlerResponse.js

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

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

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

package/dist/types/handler/media/catalog/createCatalogHandler.js

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

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

@@ -0,0 +1,7 @@
+type MetaPreview = {
+    readonly id: string;
+    readonly type: string;
+    readonly name: string;
+    readonly poster: string;
+};
+export default MetaPreview;

package/dist/types/handler/media/catalog/metaPreview.js

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

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

@@ -0,0 +1,10 @@
+import BaseHandlerArgs from "../base/baseHandlerArgs";
+import BaseHandlerResponse from "../base/baseHandlerResponse";
+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/createResourceHandler.js

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

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

@@ -0,0 +1,15 @@
+import BaseHandlerArgs from "../base/baseHandlerArgs";
+import BaseHandlerResponse from "../base/baseHandlerResponse";
+import ResourceType from "./resourceType";
+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: HandlerTypes | string;
+    resourceType: ResourceType | string;
+};
+export default ResourceHandler;

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

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

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

@@ -0,0 +1,2 @@
+type ResourceType = 'movie' | 'series';
+export default ResourceType;

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

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

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/dist/types/pluginConfig.d.ts

@@ -0,0 +1,6 @@
+type PluginConfig = {
+    readonly id: string;
+    readonly name: string;
+    readonly version: string;
+};
+export default PluginConfig;

package/dist/types/pluginConfig.js

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

package/dist/types/pluginSpec.d.ts

@@ -0,0 +1,8 @@
+import PluginConfig from "./pluginConfig";
+import Handler from "./handler/base/handler";
+export default interface PluginSpec {
+    readonly config: PluginConfig;
+    readonly onLoad: () => Promise<void>;
+    readonly onUnload: () => Promise<void>;
+    readonly handlers: Map<string, Handler>;
+}

package/dist/types/pluginSpec.js

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

package/package.json

@@ -1,19 +1,17 @@
 {
   "name": "@d-najd/universal-media-tracker-sdk",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "main": "dist/index.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "dist/types/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsup src/index.ts --format esm --dts --clean"
+    "build": "tsc"
   },
   "license": "MIT",
   "type": "module",
   "devDependencies": {
-    "tsup": "^8.5.1",
     "typescript": "^5.9.3"
   }
 }