@d-najd/universal-media-tracker-sdk 0.1.10 → 0.2.0

package/dist/index.d.ts

@@ -1,7 +1,10 @@
 export { default as Plugin } from './Plugin';
+export { default as TriState } from './types/TriState';
 export { default as PluginSpec } from './types/PluginSpec';
 export { default as PluginConfig } from './types/PluginConfig';
 export { default as ResourceType } from './types/handler/media/ResourceType';
+export { default as ResourceHandlerResponse } from './types/handler/media/ResourceHandlerResponse';
+export { default as ResourceHandlerArgs } from './types/handler/media/ResourceHandlerArgs';
 export { default as ResourceHandler } from './types/handler/media/ResourceHandler';
 export { default as CreateResourceHandler } from './types/handler/media/CreateResourceHandler';
 export { default as BaseResourceHandler } from './types/handler/media/BaseResourceHandler';
@@ -11,13 +14,16 @@ 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';
+export { default as ResourceBrowseOptionDefaults } from './types/handler/media/browse-option/ResourceBrowseOptionDefaults';
+export { default as ResourceBrowseOptionArgs } from './types/handler/media/browse-option/ResourceBrowseOptionArgs';
+export { default as ResourceBrowseOption } from './types/handler/media/browse-option/ResourceBrowseOption';

package/dist/types/TriState.d.ts

@@ -0,0 +1,2 @@
+type TriState = 'include' | 'exclude' | 'unspecified';
+export default TriState;

package/dist/types/TriState.js

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

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

@@ -3,8 +3,8 @@
  * @see Handler
  */
 type BaseHandler<T = any, R = any> = {
-    id?: string;
-    type?: string;
-    callback: (args: T) => Promise<R>;
+    readonly id?: string;
+    readonly type?: string;
+    readonly callback: (args: T) => Promise<R>;
 };
 export default BaseHandler;

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

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

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

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

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

@@ -1,8 +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>;
+    readonly id: string;
+    readonly type: HandlerTypes | string;
+    readonly callback: (args: T) => Promise<R>;
 };
 export default Handler;

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

@@ -1,9 +1,11 @@
-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;
+import ResourceBrowseOption from "./browse-option/ResourceBrowseOption";
+import ResourceHandlerArgs from "./ResourceHandlerArgs";
+import ResourceHandlerResponse from "./ResourceHandlerResponse";
+type BaseResourceHandler<T extends ResourceHandlerArgs = ResourceHandlerArgs, R extends ResourceHandlerResponse = ResourceHandlerResponse> = BaseHandler<T, R> & {
+    readonly name?: string;
+    readonly resourceType?: ResourceType | string;
+    readonly extra?: ResourceBrowseOption[];
 };
 export default BaseResourceHandler;

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

@@ -1,10 +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;
+import ResourceHandlerArgs from "./ResourceHandlerArgs";
+import ResourceHandlerResponse from "./ResourceHandlerResponse";
+type CreateResourceHandler<T extends ResourceHandlerArgs = ResourceHandlerArgs, R extends ResourceHandlerResponse = ResourceHandlerResponse> = BaseResourceHandler<T, R> & {
+    readonly type: HandlerTypes | string;
+    readonly resourceType: ResourceType | string;
 };
 export default CreateResourceHandler;

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

@@ -0,0 +1,6 @@
+type ResourceExtra = {
+    readonly name: string;
+    readonly type: 'string' | 'number' | 'radio' | 'checkbox';
+    readonly isRequired?: boolean;
+};
+export default ResourceExtra;

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

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

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

@@ -1,15 +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> & {
+import ResourceHandlerArgs from "./ResourceHandlerArgs";
+import ResourceHandlerResponse from "./ResourceHandlerResponse";
+type ResourceHandler<T extends ResourceHandlerArgs = ResourceHandlerArgs, R extends ResourceHandlerResponse = ResourceHandlerResponse> = BaseResourceHandler<T, R> & Handler<T, R> & {
     /**
      * Displayed in the app
      */
-    name: string;
-    type: HandlerTypes | string;
-    resourceType: ResourceType | string;
+    readonly name: string;
+    readonly type: HandlerTypes | string;
+    readonly resourceType: ResourceType | string;
 };
 export default ResourceHandler;

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

@@ -0,0 +1,6 @@
+import BaseHandlerArgs from "../base/BaseHandlerArgs";
+import ResourceBrowseOption from "./browse-option/ResourceBrowseOption";
+type ResourceHandlerArgs = BaseHandlerArgs & {
+    readonly browseOptions?: ResourceBrowseOption[];
+};
+export default ResourceHandlerArgs;

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

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

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

@@ -0,0 +1,3 @@
+import BaseHandlerResponse from "../base/BaseHandlerResponse";
+type ResourceHandlerResponse<T = any> = BaseHandlerResponse<T> & {};
+export default ResourceHandlerResponse;

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

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

package/dist/types/handler/media/browse-option/ResourceBrowseOption.d.ts

@@ -0,0 +1,29 @@
+import { ResourceBrowseOptionDefaults } from "./ResourceBrowseOptionDefaults";
+/**
+ * @see ResourceBrowseOptionDefaults
+ * @see ResourceBrowseOptionArgs
+ */
+type ResourceBrowseOption = {
+    readonly name: ResourceBrowseOptionDefaults | string;
+    /**
+     * Maps to values in `ResourceExtraArgs`
+     * `string` to `string`
+     * `number` to `number`
+     * `radio` to `string` uses `options`
+     * `checkbox` to `string[]` uses `options`
+     * `direction` to `asc | desc` optional `options`
+     * `radioTriState` to `TriState` uses `options`
+     * `checkboxTriState` to `TriState[]` uses `options`
+     * @see ResourceBrowseOption
+     */
+    readonly type: 'string' | 'number' | 'radio' | 'checkbox' | 'direction' | 'radioTriState' | 'checkboxTriState';
+    /**
+     * Used if there are multiple options, to define which they are, like [action, adventure, drama]
+     */
+    readonly options?: string[];
+    /**
+     * @default false
+     */
+    readonly isRequired?: boolean;
+};
+export default ResourceBrowseOption;

package/dist/types/handler/media/browse-option/ResourceBrowseOption.js

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

package/dist/types/handler/media/browse-option/ResourceBrowseOptionArgs.d.ts

@@ -0,0 +1,9 @@
+import TriState from "../../../TriState";
+type ResourceBrowseOptionArgs = {
+    readonly name: string;
+    /**
+     * @see ResourceExtra
+     */
+    readonly input: string | number | string[] | ('asc' | 'desc') | TriState | TriState[];
+};
+export default ResourceBrowseOptionArgs;

package/dist/types/handler/media/browse-option/ResourceBrowseOptionArgs.js

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

package/dist/types/handler/media/browse-option/ResourceBrowseOptionDefaults.d.ts

@@ -0,0 +1,3 @@
+type ResourceBrowseOptionDefaults = 'search' | // type string
+'skip';
+export default ResourceBrowseOptionDefaults;

package/dist/types/handler/media/browse-option/ResourceBrowseOptionDefaults.js

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

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

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

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

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

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

@@ -3,6 +3,6 @@ import CatalogHandlerArgs from "./CatalogHandlerArgs";
 import CatalogHandlerResponse from "./CatalogHandlerResponse";
 import ResourceType from "../ResourceType";
 type CreateCatalogHandler = BaseResourceHandler<CatalogHandlerArgs, CatalogHandlerResponse> & {
-    resourceType: ResourceType | string;
+    readonly resourceType: ResourceType | string;
 };
 export default CreateCatalogHandler;

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

@@ -1,4 +1,4 @@
 type PluginFactoryHandlerArgs = {
-    url: string;
+    readonly url: string;
 };
 export default PluginFactoryHandlerArgs;

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

@@ -1,4 +1,4 @@
 type PluginSourceHandlerArgs = {
-    url: string;
+    readonly url: string;
 };
 export default PluginSourceHandlerArgs;

package/package.json

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