@d-najd/universal-media-tracker-sdk 0.0.1 → 0.0.2

package/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@d-najd/universal-media-tracker-sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
   "main": "index.js",
   "scripts": {
     "build": "tsc"

package/.idea/material_theme_project_new.xml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="MaterialThemeProjectNewConfig">
-    <option name="metadata">
-      <MTProjectMetadataState>
-        <option name="migrated" value="true" />
-        <option name="pristineConfig" value="false" />
-        <option name="userId" value="-6b4e7951:198ec88be16:-7ffe" />
-      </MTProjectMetadataState>
-    </option>
-  </component>
-</project>

package/src/pluginSdk.ts

@@ -1,87 +0,0 @@
-import PluginConfig from "./types/pluginConfig";
-import Handler from "./types/handler/base/handler";
-import CreateResourceHandler from "./types/handler/media/createResourceHandler";
-import ResourceHandler from "./types/handler/media/resourceHandler";
-import CreateCatalogHandler from "./types/handler/media/catalog/createCatalogHandler";
-import PluginSpec from "./types/pluginSpec";
-
-export default class Plugin {
-	readonly config: PluginConfig
-	private handlers = new Map<string, Handler>()
-
-	private counter = 0
-	private loaded = false
-
-	constructor(options: PluginConfig) {
-		this.config = options
-	}
-
-	/**
-	 * Don't define handlers here, they are part of the spec
-	 */
-	onLoad(callback: () => Promise<void>) {
-		this.onLoadCallback = async () => {
-			await callback()
-			this.loaded = true
-		}
-	}
-
-	onUnload(callback: () => Promise<void>) {
-		this.onUnloadCallback = async () => {
-			await callback()
-			this.loaded = false
-		}
-	}
-
-	/**
-	 * @see Handler
-	 */
-	defineResourceHandler(handler: CreateResourceHandler): string {
-		const newHandler: ResourceHandler = {
-			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: CreateCatalogHandler): string {
-		const newHandler: CreateResourceHandler = {
-			id: `${this.config.id}-catalog-handler`,
-			...handler,
-			type: 'catalog-request'
-		}
-
-		return this.defineResourceHandler(newHandler)
-	}
-
-	// Used internally, private since its internal api
-	// noinspection JSUnusedLocalSymbols
-	private getSpec(): PluginSpec {
-		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
-		}
-	}
-
-	private onLoadCallback: () => Promise<void> = async () => {
-		this.loaded = true
-	}
-
-	private onUnloadCallback: () => Promise<void> = async () => {
-		this.loaded = false
-	}
-}

package/src/types/handler/base/baseHandlerArgs.ts

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

package/src/types/handler/base/baseHandlerResponse.ts

@@ -1,6 +0,0 @@
-// eslint-disable-next-line
-type BaseHandlerResponse<T = any> = {
-	readonly data: T[]
-}
-
-export default BaseHandlerResponse

package/src/types/handler/base/handler.ts

@@ -1,20 +0,0 @@
-/*
- * 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
- */
-
-// eslint-disable-next-line
-type Handler<T = any, R = any> = {
-	id: string
-	type: string
-	callback: (args: T) => Promise<R>
-}
-
-export default Handler

package/src/types/handler/media/catalog/catalogHandlerArgs.ts

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

package/src/types/handler/media/catalog/catalogHandlerResponse.ts

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

package/src/types/handler/media/catalog/createCatalogHandler.ts

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

package/src/types/handler/media/catalog/metaPreview.ts

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

package/src/types/handler/media/createResourceHandler.ts

@@ -1,13 +0,0 @@
-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
-}
-
-export default CreateResourceHandler

package/src/types/handler/media/resourceHandler.ts

@@ -1,19 +0,0 @@
-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> & {
-	/**
-	 * Displayed in the app
-	 */
-	name: string
-	type: ResourceHandlerType | string
-	resourceType: ResourceType | string
-}
-
-export default ResourceHandler

package/src/types/handler/media/resourceHandlerType.ts

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

package/src/types/handler/media/resourceType.ts

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

package/src/types/pluginConfig.ts

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

package/src/types/pluginSpec.ts

@@ -1,9 +0,0 @@
-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/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-	"target": "es2018",
-	"module": "ESNext",
-	"declaration": true,
-	"outDir": "dist",
-	"strict": true,
-	"esModuleInterop": true
-  },
-  "include": ["src"]
-}