@d-najd/universal-media-tracker-sdk 0.3.3 → 0.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Plugin.d.ts +15 -7
- package/dist/Plugin.js +10 -1
- package/dist/index.d.ts +7 -6
- package/dist/navigator/Navigator.d.ts +1 -1
- package/dist/types/PluginSpec.d.ts +2 -2
- package/dist/types/handler/base/CreateHandler.d.ts +1 -1
- package/dist/types/handler/base/Handler.d.ts +2 -2
- package/dist/types/handler/media/BaseResourceHandler.d.ts +5 -5
- package/dist/types/handler/media/CreateResourceHandler.d.ts +5 -5
- package/dist/types/handler/media/ResourceHandler.d.ts +6 -6
- package/dist/types/handler/media/ResourceHandlerArgs.d.ts +1 -1
- package/dist/types/handler/media/browse-option/ResourceBrowseOption.d.ts +1 -1
- package/dist/types/handler/media/browse-option/ResourceBrowseOptionArgs.d.ts +2 -2
- package/dist/types/handler/media/browse-option/ResourceBrowseOptionDefaults.d.ts +1 -3
- package/dist/types/handler/media/catalog/CatalogHandlerArgs.d.ts +1 -1
- package/dist/types/handler/media/catalog/CatalogHandlerResponse.d.ts +2 -2
- package/dist/types/handler/media/catalog/CreateCatalogHandler.d.ts +4 -4
- package/dist/types/handler/media/catalog/MetaPreview.d.ts +1 -1
- package/dist/types/handler/plugin/factory/CreatePluginFactoryHandler.d.ts +3 -3
- package/dist/types/handler/plugin/source/CreatePluginSourceHandler.d.ts +3 -3
- package/dist/types/handler/ui/screen/CreateCustomScreenHandler.d.ts +14 -0
- package/dist/types/handler/ui/screen/CreateCustomScreenHandler.js +1 -0
- package/dist/types/handler/ui/screen/CreateScreenHandler.d.ts +6 -14
- package/dist/types/handler/ui/screen/ScreenHandlerArgs.d.ts +1 -2
- package/dist/types/handler/ui/screen/ScreenHandlerResponse.d.ts +1 -2
- package/package.json +30 -28
package/dist/Plugin.d.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
import PluginConfig from
|
|
2
|
-
import CreateCatalogHandler from
|
|
3
|
-
import CreateResourceHandler from
|
|
4
|
-
import CreatePluginSourceHandler from
|
|
5
|
-
import CreateHandler from
|
|
6
|
-
import CreatePluginFactoryHandler from
|
|
7
|
-
import CreateScreenHandler from
|
|
1
|
+
import PluginConfig from './types/PluginConfig';
|
|
2
|
+
import CreateCatalogHandler from './types/handler/media/catalog/CreateCatalogHandler';
|
|
3
|
+
import CreateResourceHandler from './types/handler/media/CreateResourceHandler';
|
|
4
|
+
import CreatePluginSourceHandler from './types/handler/plugin/source/CreatePluginSourceHandler';
|
|
5
|
+
import CreateHandler from './types/handler/base/CreateHandler';
|
|
6
|
+
import CreatePluginFactoryHandler from './types/handler/plugin/factory/CreatePluginFactoryHandler';
|
|
7
|
+
import CreateScreenHandler from './types/handler/ui/screen/CreateScreenHandler';
|
|
8
|
+
import CreateCustomScreenHandler from './types/handler/ui/screen/CreateCustomScreenHandler';
|
|
8
9
|
export default class Plugin {
|
|
9
10
|
readonly config: PluginConfig;
|
|
10
11
|
/**
|
|
@@ -33,7 +34,14 @@ export default class Plugin {
|
|
|
33
34
|
defineCatalogHandler(handler: CreateCatalogHandler): string;
|
|
34
35
|
definePluginSourceHandler(handler: CreatePluginSourceHandler): string;
|
|
35
36
|
definePluginFactoryHandler(handler: CreatePluginFactoryHandler): string;
|
|
37
|
+
/**
|
|
38
|
+
* Recommended version of defining screens since it has some tested defaults
|
|
39
|
+
*/
|
|
36
40
|
defineScreenHandler(handler: CreateScreenHandler): string;
|
|
41
|
+
/**
|
|
42
|
+
* Advanced version of defining screens, may lead to memory leaks if used misused
|
|
43
|
+
*/
|
|
44
|
+
defineCustomScreenHandler(handler: CreateCustomScreenHandler): string;
|
|
37
45
|
private getSpec;
|
|
38
46
|
private onLoadCallback;
|
|
39
47
|
private onUnloadCallback;
|
package/dist/Plugin.js
CHANGED
|
@@ -75,11 +75,20 @@ export default class Plugin {
|
|
|
75
75
|
};
|
|
76
76
|
return this.defineHandler(newHandler);
|
|
77
77
|
}
|
|
78
|
+
/**
|
|
79
|
+
* Recommended version of defining screens since it has some tested defaults
|
|
80
|
+
*/
|
|
78
81
|
defineScreenHandler(handler) {
|
|
82
|
+
return this.defineCustomScreenHandler(handler);
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Advanced version of defining screens, may lead to memory leaks if used misused
|
|
86
|
+
*/
|
|
87
|
+
defineCustomScreenHandler(handler) {
|
|
79
88
|
const newHandler = {
|
|
80
89
|
id: `${this.config.id}-ui-screen-${this.counter++}`,
|
|
81
90
|
...handler,
|
|
82
|
-
type:
|
|
91
|
+
type: 'ui-screen'
|
|
83
92
|
};
|
|
84
93
|
return this.defineHandler(newHandler);
|
|
85
94
|
}
|
package/dist/index.d.ts
CHANGED
|
@@ -17,6 +17,13 @@ export { default as BaseHandler } from './types/handler/base/BaseHandler';
|
|
|
17
17
|
export { default as ScreenHandlerResponse } from './types/handler/ui/screen/ScreenHandlerResponse';
|
|
18
18
|
export { default as ScreenHandlerArgs } from './types/handler/ui/screen/ScreenHandlerArgs';
|
|
19
19
|
export { default as CreateScreenHandler } from './types/handler/ui/screen/CreateScreenHandler';
|
|
20
|
+
export { default as CreateCustomScreenHandler } from './types/handler/ui/screen/CreateCustomScreenHandler';
|
|
21
|
+
export { default as PluginSourceHandlerResponse } from './types/handler/plugin/source/PluginSourceHandlerResponse';
|
|
22
|
+
export { default as PluginSourceHandlerArgs } from './types/handler/plugin/source/PluginSourceHandlerArgs';
|
|
23
|
+
export { default as CreatePluginSourceHandler } from './types/handler/plugin/source/CreatePluginSourceHandler';
|
|
24
|
+
export { default as PluginFactoryHandlerResponse } from './types/handler/plugin/factory/PluginFactoryHandlerResponse';
|
|
25
|
+
export { default as PluginFactoryHandlerArgs } from './types/handler/plugin/factory/PluginFactoryHandlerArgs';
|
|
26
|
+
export { default as CreatePluginFactoryHandler } from './types/handler/plugin/factory/CreatePluginFactoryHandler';
|
|
20
27
|
export { default as MetaPreview } from './types/handler/media/catalog/MetaPreview';
|
|
21
28
|
export { default as CreateCatalogHandler } from './types/handler/media/catalog/CreateCatalogHandler';
|
|
22
29
|
export { default as CatalogHandlerResponse } from './types/handler/media/catalog/CatalogHandlerResponse';
|
|
@@ -24,9 +31,3 @@ export { default as CatalogHandlerArgs } from './types/handler/media/catalog/Cat
|
|
|
24
31
|
export { default as ResourceBrowseOptionDefaults } from './types/handler/media/browse-option/ResourceBrowseOptionDefaults';
|
|
25
32
|
export { default as ResourceBrowseOptionArgs } from './types/handler/media/browse-option/ResourceBrowseOptionArgs';
|
|
26
33
|
export { default as ResourceBrowseOption } from './types/handler/media/browse-option/ResourceBrowseOption';
|
|
27
|
-
export { default as PluginSourceHandlerResponse } from './types/handler/plugin/source/PluginSourceHandlerResponse';
|
|
28
|
-
export { default as PluginSourceHandlerArgs } from './types/handler/plugin/source/PluginSourceHandlerArgs';
|
|
29
|
-
export { default as CreatePluginSourceHandler } from './types/handler/plugin/source/CreatePluginSourceHandler';
|
|
30
|
-
export { default as PluginFactoryHandlerResponse } from './types/handler/plugin/factory/PluginFactoryHandlerResponse';
|
|
31
|
-
export { default as PluginFactoryHandlerArgs } from './types/handler/plugin/factory/PluginFactoryHandlerArgs';
|
|
32
|
-
export { default as CreatePluginFactoryHandler } from './types/handler/plugin/factory/CreatePluginFactoryHandler';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import PluginConfig from
|
|
2
|
-
import Handler from
|
|
1
|
+
import PluginConfig from './PluginConfig';
|
|
2
|
+
import Handler from './handler/base/Handler';
|
|
3
3
|
export default interface PluginSpec {
|
|
4
4
|
readonly config: PluginConfig;
|
|
5
5
|
readonly onLoad: () => Promise<void>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import BaseHandler from
|
|
2
|
-
import HandlerTypes from
|
|
1
|
+
import BaseHandler from './BaseHandler';
|
|
2
|
+
import HandlerTypes from './HandlerTypes';
|
|
3
3
|
type Handler<T = any, R = any> = BaseHandler<T, R> & {
|
|
4
4
|
readonly id: string;
|
|
5
5
|
readonly type: HandlerTypes | string;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import ResourceType from
|
|
2
|
-
import BaseHandler from
|
|
3
|
-
import ResourceBrowseOption from
|
|
4
|
-
import ResourceHandlerArgs from
|
|
5
|
-
import ResourceHandlerResponse from
|
|
1
|
+
import ResourceType from './ResourceType';
|
|
2
|
+
import BaseHandler from '../base/BaseHandler';
|
|
3
|
+
import ResourceBrowseOption from './browse-option/ResourceBrowseOption';
|
|
4
|
+
import ResourceHandlerArgs from './ResourceHandlerArgs';
|
|
5
|
+
import ResourceHandlerResponse from './ResourceHandlerResponse';
|
|
6
6
|
type BaseResourceHandler<T extends ResourceHandlerArgs = ResourceHandlerArgs, R extends ResourceHandlerResponse = ResourceHandlerResponse> = BaseHandler<T, R> & {
|
|
7
7
|
readonly name?: string;
|
|
8
8
|
readonly resourceType?: ResourceType | string;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import BaseResourceHandler from
|
|
2
|
-
import ResourceType from
|
|
3
|
-
import HandlerTypes from
|
|
4
|
-
import ResourceHandlerArgs from
|
|
5
|
-
import ResourceHandlerResponse from
|
|
1
|
+
import BaseResourceHandler from './BaseResourceHandler';
|
|
2
|
+
import ResourceType from './ResourceType';
|
|
3
|
+
import HandlerTypes from '../base/HandlerTypes';
|
|
4
|
+
import ResourceHandlerArgs from './ResourceHandlerArgs';
|
|
5
|
+
import ResourceHandlerResponse from './ResourceHandlerResponse';
|
|
6
6
|
type CreateResourceHandler<T extends ResourceHandlerArgs = ResourceHandlerArgs, R extends ResourceHandlerResponse = ResourceHandlerResponse> = BaseResourceHandler<T, R> & {
|
|
7
7
|
readonly type: HandlerTypes | string;
|
|
8
8
|
readonly resourceType: ResourceType | string;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import ResourceType from
|
|
2
|
-
import BaseResourceHandler from
|
|
3
|
-
import Handler from
|
|
4
|
-
import HandlerTypes from
|
|
5
|
-
import ResourceHandlerArgs from
|
|
6
|
-
import ResourceHandlerResponse from
|
|
1
|
+
import ResourceType from './ResourceType';
|
|
2
|
+
import BaseResourceHandler from './BaseResourceHandler';
|
|
3
|
+
import Handler from '../base/Handler';
|
|
4
|
+
import HandlerTypes from '../base/HandlerTypes';
|
|
5
|
+
import ResourceHandlerArgs from './ResourceHandlerArgs';
|
|
6
|
+
import ResourceHandlerResponse from './ResourceHandlerResponse';
|
|
7
7
|
type ResourceHandler<T extends ResourceHandlerArgs = ResourceHandlerArgs, R extends ResourceHandlerResponse = ResourceHandlerResponse> = BaseResourceHandler<T, R> & Handler<T, R> & {
|
|
8
8
|
/**
|
|
9
9
|
* Displayed in the app
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import TriState from
|
|
2
|
-
import ResourceBrowseOptionDefaults from
|
|
1
|
+
import TriState from '../../../TriState';
|
|
2
|
+
import ResourceBrowseOptionDefaults from './ResourceBrowseOptionDefaults';
|
|
3
3
|
type ResourceBrowseOptionArgs = {
|
|
4
4
|
readonly name: ResourceBrowseOptionDefaults | string;
|
|
5
5
|
/**
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import MetaPreview from
|
|
2
|
-
import ResourceHandlerResponse from
|
|
1
|
+
import MetaPreview from './MetaPreview';
|
|
2
|
+
import ResourceHandlerResponse from '../ResourceHandlerResponse';
|
|
3
3
|
type CatalogHandlerResponse = ResourceHandlerResponse<MetaPreview> & {};
|
|
4
4
|
export default CatalogHandlerResponse;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import BaseResourceHandler from
|
|
2
|
-
import CatalogHandlerArgs from
|
|
3
|
-
import CatalogHandlerResponse from
|
|
4
|
-
import ResourceType from
|
|
1
|
+
import BaseResourceHandler from '../BaseResourceHandler';
|
|
2
|
+
import CatalogHandlerArgs from './CatalogHandlerArgs';
|
|
3
|
+
import CatalogHandlerResponse from './CatalogHandlerResponse';
|
|
4
|
+
import ResourceType from '../ResourceType';
|
|
5
5
|
type CreateCatalogHandler = BaseResourceHandler<CatalogHandlerArgs, CatalogHandlerResponse> & {
|
|
6
6
|
readonly resourceType: ResourceType | string;
|
|
7
7
|
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import BaseHandler from
|
|
2
|
-
import PluginFactoryHandlerArgs from
|
|
3
|
-
import PluginFactoryHandlerResponse from
|
|
1
|
+
import BaseHandler from '../../base/BaseHandler';
|
|
2
|
+
import PluginFactoryHandlerArgs from './PluginFactoryHandlerArgs';
|
|
3
|
+
import PluginFactoryHandlerResponse from './PluginFactoryHandlerResponse';
|
|
4
4
|
type CreatePluginFactoryHandler = BaseHandler<PluginFactoryHandlerArgs, PluginFactoryHandlerResponse> & {};
|
|
5
5
|
export default CreatePluginFactoryHandler;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import PluginSourceHandlerResponse from
|
|
2
|
-
import BaseHandler from
|
|
3
|
-
import PluginSourceHandlerArgs from
|
|
1
|
+
import PluginSourceHandlerResponse from './PluginSourceHandlerResponse';
|
|
2
|
+
import BaseHandler from '../../base/BaseHandler';
|
|
3
|
+
import PluginSourceHandlerArgs from './PluginSourceHandlerArgs';
|
|
4
4
|
type CreatePluginSourceHandler = BaseHandler<PluginSourceHandlerArgs, PluginSourceHandlerResponse> & {};
|
|
5
5
|
export default CreatePluginSourceHandler;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import BaseHandler from '../../base/BaseHandler';
|
|
2
|
+
import ScreenHandlerArgs from './ScreenHandlerArgs';
|
|
3
|
+
import ScreenHandlerResponse from './ScreenHandlerResponse';
|
|
4
|
+
type CreateCustomScreenHandler<S = any> = BaseHandler<ScreenHandlerArgs<S>, ScreenHandlerResponse> & {
|
|
5
|
+
/**
|
|
6
|
+
* /library/:id
|
|
7
|
+
*/
|
|
8
|
+
readonly pattern: string;
|
|
9
|
+
/**
|
|
10
|
+
* If undefined screen state won't be stored
|
|
11
|
+
*/
|
|
12
|
+
readonly initialState?: S;
|
|
13
|
+
};
|
|
14
|
+
export default CreateCustomScreenHandler;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,15 +1,7 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
* /library/:id
|
|
8
|
-
*/
|
|
9
|
-
readonly pattern: string;
|
|
10
|
-
/**
|
|
11
|
-
* If undefined screen state won't be stored
|
|
12
|
-
*/
|
|
13
|
-
readonly initialState?: UseBoundStore<StoreApi<S>>;
|
|
14
|
-
};
|
|
1
|
+
import { StoreApi, UseBoundStore } from 'zustand';
|
|
2
|
+
import CreateCustomScreenHandler from './CreateCustomScreenHandler';
|
|
3
|
+
/**
|
|
4
|
+
* Uses zustand, react is also recommended
|
|
5
|
+
*/
|
|
6
|
+
type CreateScreenHandler<S = any> = CreateCustomScreenHandler<UseBoundStore<StoreApi<S>>> & {};
|
|
15
7
|
export default CreateScreenHandler;
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import Navigator from '../../../../navigator/Navigator';
|
|
2
|
-
import { UseBoundStore, StoreApi } from "zustand";
|
|
3
2
|
type ScreenHandlerArgs<S = any> = {
|
|
4
3
|
/**
|
|
5
4
|
* If undefined in handler won't be passed here
|
|
6
5
|
*/
|
|
7
|
-
readonly state?:
|
|
6
|
+
readonly state?: S;
|
|
8
7
|
readonly navigator: Navigator;
|
|
9
8
|
/**
|
|
10
9
|
* /library/1
|
package/package.json
CHANGED
|
@@ -1,30 +1,32 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
2
|
+
"name": "@d-najd/universal-media-tracker-sdk",
|
|
3
|
+
"version": "0.3.4",
|
|
4
|
+
"main": "dist/index.js",
|
|
5
|
+
"types": "dist/index.d.ts",
|
|
6
|
+
"files": [
|
|
7
|
+
"dist"
|
|
8
|
+
],
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"import": "./dist/index.js",
|
|
12
|
+
"require": "./dist/index.js",
|
|
13
|
+
"types": "./dist/index.d.ts"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"scripts": {
|
|
17
|
+
"build": "rimraf dist & node scripts/generate.js && tsc",
|
|
18
|
+
"format": "prettier --write ."
|
|
19
|
+
},
|
|
20
|
+
"license": "MIT",
|
|
21
|
+
"type": "module",
|
|
22
|
+
"devDependencies": {
|
|
23
|
+
"@types/node": "^25.5.2",
|
|
24
|
+
"@types/react": "^19.2.14",
|
|
25
|
+
"glob": "^13.0.6",
|
|
26
|
+
"prettier": "^3.8.1",
|
|
27
|
+
"typescript": "^5.9.3"
|
|
28
|
+
},
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"zustand": "^5.0.12"
|
|
31
|
+
}
|
|
30
32
|
}
|