;
/**
* Build metadata function
*
+ * @typeParam S - the io-ts codec type for source
+ * @typeParam M - the io-ts codec type for metadata
+ * @typeParam PP - the typeof of the map of string => parser
+ *
* @param e The payload produced by the pipeline
* @param metadata - The metadata already present in the DB, if any
*/
@@ -717,10 +741,16 @@ let lastExecution: Date;
let computedFrequency = 10;
/**
+ * Create a parser instance
+ *
+ * @typeParam S - the io-ts codec type for source
+ * @typeParam M - the io-ts codec type for metadata
+ * @typeParam C - the parser configuration type
+ * @typeParam PP - the typeof of the map of string => parser
*
- * @param name
+ * @param name - The parser name
* @param ctx - The parser context {@link ParserProviderContext}
- * @returns
+ * @returns a {@link ParserProvider} instance
*/
export const GetParserProvider = <
S extends t.Mixed,
diff --git a/packages/shared/src/utils/arbitrary.utils.ts b/packages/shared/src/utils/arbitrary.utils.ts
index 7772796d7..0deb18074 100644
--- a/packages/shared/src/utils/arbitrary.utils.ts
+++ b/packages/shared/src/utils/arbitrary.utils.ts
@@ -3,20 +3,24 @@ import * as R from 'fp-ts/lib/Record';
import { pipe } from 'fp-ts/lib/function';
import * as t from 'io-ts';
-export const propsOmit = >(
- codec: t.ExactC>,
- props: PP
-): Omit =>
- pipe(
- codec.type.props,
- R.filterMapWithIndex((k, p) =>
- pipe(
- p,
- O.fromPredicate(() => !props.includes(k))
- )
- ) as any
- );
-
+/**
+ *
+ * Strip io-ts t.type codec props from a given array of keys
+ *
+ * * ```ts
+ * const codec = t.type({ id: t.string, name: t.string });
+ * const onlyIdCodec = propsOmitType(codec, ['name']);
+ * // onlyIdCodec = { id: t.string }
+ * ```
+ *
+ * @typeParam P - the codec props
+ * @typeParam PP - the array of codec prop keys
+ *
+ * @param codec A io-ts codec
+ * @param props A list of codec property key
+ * @returns A new map of codecs for the remaining properties
+ *
+ */
export const propsOmitType = >(
codec: t.TypeC
,
props: PP
@@ -30,3 +34,25 @@ export const propsOmitType =
>(
)
) as any
);
+
+/**
+ * Strip io-ts t.strict codec props from a given array of keys
+ *
+ * ```ts
+ * const codec = t.strict({ id: t.string, name: t.string });
+ * const onlyIdCodec = propsOmit(codec, ['name']);
+ * // onlyIdCodec = { id: t.string }
+ * ```
+ *
+ * @typeParam P - the codec props
+ * @typeParam PP - the array of codec prop keys
+ *
+ * @param codec A io-ts codec
+ * @param props A list of codec property key
+ * @returns A new map of codecs for the remaining properties
+ *
+ */
+export const propsOmit =
>(
+ codec: t.ExactC>,
+ props: PP
+): Omit => propsOmitType(codec.type, props);
diff --git a/packages/shared/src/utils/index.ts b/packages/shared/src/utils/index.ts
new file mode 100644
index 000000000..d2fbd0f70
--- /dev/null
+++ b/packages/shared/src/utils/index.ts
@@ -0,0 +1,13 @@
+export * as arbitrary from './arbitrary.utils';
+export * as csv from './csv.utils';
+export * as date from './date.utils';
+export * as decode from './decode.utils';
+export * as encode from './encode.utils';
+export * as endpoint from './endpoint.utils';
+export * as food from './food.utils';
+export * as fp from './fp.utils';
+export * as html from './html.utils';
+export * as ip from './ip.utils';
+export * as number from './number.utils';
+export * as promise from './promise.utils';
+export * as task from './task.utils';
diff --git a/packages/shared/src/utils/promise.utils.ts b/packages/shared/src/utils/promise.utils.ts
index bcb73718f..55ae62aff 100644
--- a/packages/shared/src/utils/promise.utils.ts
+++ b/packages/shared/src/utils/promise.utils.ts
@@ -1,4 +1,8 @@
-
+/**
+ * Wrap setTimeout in a promise for async timeout
+ *
+ * @param ms the time to sleep in milliseconds
+ */
export async function sleep(ms: number): Promise {
return new Promise((resolve) => {
setTimeout(resolve, ms);
diff --git a/packages/shared/src/webpack/index.ts b/packages/shared/src/webpack/index.ts
new file mode 100644
index 000000000..511d958e7
--- /dev/null
+++ b/packages/shared/src/webpack/index.ts
@@ -0,0 +1,2 @@
+export * from './config';
+export * from './extension.config';
diff --git a/packages/taboule/package.json b/packages/taboule/package.json
index aaa92c789..5ceb910ab 100644
--- a/packages/taboule/package.json
+++ b/packages/taboule/package.json
@@ -54,11 +54,17 @@
"eslint-plugin-promise": "^6.1.0",
"eslint-plugin-react": "^7.31.10",
"prettier": "^2.7.1",
- "ts-loader": "^9.4.1",
+ "ts-loader": "^9.4.2",
"typelevel-ts": "^0.4.0",
- "webpack": "^5.74.0",
- "webpack-bundle-analyzer": "^4.6.1",
+ "webpack": "^5.75.0",
+ "webpack-bundle-analyzer": "^4.7.0",
"webpack-cli": "^4.10.0",
"webpack-dev-server": "^4.11.1"
+ },
+ "typedoc": {
+ "entryPoint": "./src/index.tsx",
+ "readmeFile": "./README.md",
+ "displayName": "Taboule",
+ "tsconfig": "./tsconfig.json"
}
}
diff --git a/packages/taboule/src/config/params.ts b/packages/taboule/src/config/params.ts
index 8c3197418..5bb3ddbee 100644
--- a/packages/taboule/src/config/params.ts
+++ b/packages/taboule/src/config/params.ts
@@ -1,14 +1,19 @@
+/**
+ * @module config!params
+ */
import { TabouleQueryKey } from '../state/types';
type TabouleDefaultParams = { [K in TabouleQueryKey]: any };
+/**
+ * Default query params
+ */
export const defaultParams: TabouleDefaultParams = {
ccRelatedUsers: {},
getExperimentById: {},
getExperimentList: {
type: 'comparison',
- key: 'fuffa',
- // this is the default as per 'yarn backend watch'
+ key: 'fuffa', // this is the default as per 'yarn backend watch'
},
personalHomes: {},
personalSearches: {},
diff --git a/packages/taboule/src/index.tsx b/packages/taboule/src/index.tsx
index 3e40281c2..1447dd46e 100644
--- a/packages/taboule/src/index.tsx
+++ b/packages/taboule/src/index.tsx
@@ -5,7 +5,11 @@ import * as ReactDOM from 'react-dom';
import { Taboule, TabouleProps } from './components/Taboule';
import { TabouleQueries } from './state/queries';
-interface DataTableProps
+/**
+ * Table data props
+ * @typeParam Q - key of {@link TabouleQueries}
+ */
+export interface DataTableProps
extends TabouleProps {
node: HTMLDivElement;
}
diff --git a/packages/taboule/src/state/commands.ts b/packages/taboule/src/state/commands.ts
index 0b34d8b25..dc1e9d937 100644
--- a/packages/taboule/src/state/commands.ts
+++ b/packages/taboule/src/state/commands.ts
@@ -1,3 +1,6 @@
+/**
+ * @module state!commands
+ */
import { MakeAPIClient, TERequest } from '@shared/providers/api.provider';
import { command } from 'avenger';
import * as Endpoints from '@yttrex/shared/endpoints';
diff --git a/packages/taboule/src/state/index.ts b/packages/taboule/src/state/index.ts
index 6c853fec8..6a3ce0307 100644
--- a/packages/taboule/src/state/index.ts
+++ b/packages/taboule/src/state/index.ts
@@ -1,10 +1,8 @@
-import { GetTabouleCommands, TabouleCommands } from './commands';
-import { GetTabouleQueries, TabouleQueries } from './queries';
+/**
+ * @module state
+ */
-export const TabouleDataProvider = (
- baseURL: string
-): { queries: TabouleQueries; commands: TabouleCommands } => {
- const queries = GetTabouleQueries({ baseURL });
- const commands = GetTabouleCommands({ baseURL }, queries);
- return { queries, commands };
-};
+export * from './types';
+export * from './queries';
+export * from './commands';
+export { TabouleDataProvider } from './state.provider';
diff --git a/packages/taboule/src/state/queries.ts b/packages/taboule/src/state/queries.ts
index 410ccdc8b..6d5b432f7 100644
--- a/packages/taboule/src/state/queries.ts
+++ b/packages/taboule/src/state/queries.ts
@@ -1,3 +1,7 @@
+/**
+ * @module state!queries
+ */
+
import * as endpoints from '@yttrex/shared/endpoints';
import * as tkEndpoints from '@tktrex/shared/endpoints';
import { APIError } from '@shared/errors/APIError';
@@ -31,8 +35,20 @@ export interface Results {
content: T[];
}
-type EndpointQuery = CachedQuery>;
+/**
+ * A cached query for endpoint
+ *
+ * @typeParam C - The output
+ */
+export type EndpointQuery = CachedQuery<
+ SearchRequestInput,
+ APIError,
+ Results
+>;
+/**
+ * Taboule queries
+ */
export interface TabouleQueries {
ccRelatedUsers: EndpointQuery;
getExperimentById: EndpointQuery;
@@ -47,7 +63,7 @@ export interface TabouleQueries {
tikTokSearches: EndpointQuery;
}
-interface GetTabouleQueriesProps {
+export interface GetTabouleQueriesProps {
baseURL: string;
accessToken?: string;
}
diff --git a/packages/taboule/src/state/state.provider.ts b/packages/taboule/src/state/state.provider.ts
new file mode 100644
index 000000000..60c19f4cb
--- /dev/null
+++ b/packages/taboule/src/state/state.provider.ts
@@ -0,0 +1,17 @@
+import { GetTabouleCommands, TabouleCommands } from './commands';
+import { GetTabouleQueries, TabouleQueries } from './queries';
+/**
+ * Taboule Data Provider
+ *
+ * @module state!TabouleDataProvider
+ *
+ * @param baseURL
+ * @returns type safe queries and commands
+ */
+export const TabouleDataProvider = (
+ baseURL: string
+): { queries: TabouleQueries; commands: TabouleCommands } => {
+ const queries = GetTabouleQueries({ baseURL });
+ const commands = GetTabouleCommands({ baseURL }, queries);
+ return { queries, commands };
+};
diff --git a/packages/taboule/src/state/types.ts b/packages/taboule/src/state/types.ts
index 07e5fb2b8..3f51164d2 100644
--- a/packages/taboule/src/state/types.ts
+++ b/packages/taboule/src/state/types.ts
@@ -1,3 +1,6 @@
+/**
+ * @module state!types
+ */
import * as t from 'io-ts';
export const TabouleQueryKey = t.union(
diff --git a/platforms/guardoni/sidebars.js b/platforms/guardoni/docs/sidebars.js
similarity index 59%
rename from platforms/guardoni/sidebars.js
rename to platforms/guardoni/docs/sidebars.js
index c81f3a70e..6e509aafa 100644
--- a/platforms/guardoni/sidebars.js
+++ b/platforms/guardoni/docs/sidebars.js
@@ -16,24 +16,14 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
- tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
guardoniSidebar: [
- { type: 'autogenerated', dirName: '../../platforms/guardoni/docs' },
- ],
- tkTrexSidebar: [
- { type: 'autogenerated', dirName: '../../platforms/tktrex/docs/docs' },
- ],
-
- // But you can create a sidebar manually
- /*
- tutorialSidebar: [
+ { type: 'autogenerated', dirName: '.' },
{
- type: 'category',
- label: 'Tutorial',
- items: ['hello'],
+ label: 'Code',
+ type: 'link',
+ href: '/docs/guardoni/API',
},
],
- */
};
module.exports = sidebars;
diff --git a/platforms/guardoni/package.json b/platforms/guardoni/package.json
index ccc100b24..4b17acd2a 100644
--- a/platforms/guardoni/package.json
+++ b/platforms/guardoni/package.json
@@ -26,7 +26,8 @@
"tdd": "jest --watch --verbose",
"cli-yt-test-videos": "ts-node ./scripts/cli-yt-test-videos.mjs",
"cli-yt-test-home": "ts-node ./scripts/cli-yt-test-home-fixures.mjs",
- "cli-yt-test-from-fixtures": "ts-node ./scripts/cli-yt-test-home-fixures.mjs"
+ "cli-yt-test-from-fixtures": "ts-node ./scripts/cli-yt-test-home-fixures.mjs",
+ "typedoc": "typedoc"
},
"bin": {
"cli": "./bin/guardoni-cli.js"
@@ -123,14 +124,14 @@
"string-replace-loader": "^3.1.0",
"style-loader": "^3.3.1",
"ts-jest": "^27.1.5",
- "ts-loader": "^9.4.1",
+ "ts-loader": "^9.4.2",
"ts-node": "^10.9.1",
"tsconfig-paths": "^4.1.0",
"typescript": "^4.8.4",
"unlazy-loader": "^0.1.3",
"utf-8-validate": "^5.0.9",
- "webpack": "^5.74.0",
- "webpack-bundle-analyzer": "^4.6.1",
+ "webpack": "^5.75.0",
+ "webpack-bundle-analyzer": "^4.7.0",
"webpack-cli": "^4.10.0",
"webpack-node-externals": "^3.0.0"
},
diff --git a/platforms/guardoni/src/guardoni/extension.ts b/platforms/guardoni/src/guardoni/extension.ts
index ee2fcf560..666bbc9e1 100644
--- a/platforms/guardoni/src/guardoni/extension.ts
+++ b/platforms/guardoni/src/guardoni/extension.ts
@@ -153,8 +153,6 @@ export const downloadExtension = (
/**
* Clean extension directory
*
- * @param ctx
- * @returns
*/
export const cleanExtension =
diff --git a/platforms/guardoni/typedoc.json b/platforms/guardoni/typedoc.json
new file mode 100644
index 000000000..2306edc38
--- /dev/null
+++ b/platforms/guardoni/typedoc.json
@@ -0,0 +1,19 @@
+{
+ "$schema": "https://typedoc.org/schema.json",
+ "entryPoints": [
+ "./src/guardoni/cli.ts",
+ "../../packages/shared/src/endpoints/*"
+ ],
+ "out": "docs/api",
+ "exclude": ["build", "**/build"],
+ "plugin": [
+ "typedoc-plugin-missing-exports",
+ "typedoc-plugin-resolve-crossmodule-references",
+ "typedoc-plugin-markdown"
+ ],
+ "validation": {
+ "notExported": true,
+ "invalidLink": true,
+ "notDocumented": false
+ }
+}
diff --git a/platforms/storybook/package.json b/platforms/storybook/package.json
index c76b00816..c36cb081f 100644
--- a/platforms/storybook/package.json
+++ b/platforms/storybook/package.json
@@ -36,7 +36,7 @@
"eslint-plugin-react": "^7.31.10",
"prop-types": "^15.8.1",
"typescript": "^4.8.4",
- "webpack": "^5.74.0"
+ "webpack": "^5.75.0"
},
"browserslist": {
"production": [
diff --git a/platforms/tktrex/backend/README.md b/platforms/tktrex/backend/README.md
index 1c0471ddf..5c0e21db6 100644
--- a/platforms/tktrex/backend/README.md
+++ b/platforms/tktrex/backend/README.md
@@ -1,3 +1,4 @@
+# TK - Backend
Requirements:
@@ -6,4 +7,19 @@ Requirements:
- npm install
- npm run watch
-This is only the backend system, as for the frontend, you should check: https://github.com/tracking-exposed/tiktok.tracking.exposed
+This is only the backend system, as for the frontend, you should check: [tracking-exposed/tiktok.tracking.exposed](https://github.com/tracking-exposed/tiktok.tracking.exposed)
+
+### How to use count-o-clock from crontab
+
+```sh
+1 * * * * cd platforms/tktrex/backend/; DEBUG=* node bin/count-o-clock.js --hoursago 1 2>&1| tee -a /tmp/count-o-clock.log
+```
+
+How to repeat executions that have been missed
+
+```sh
+cd platforms/tktrex/backend$
+$ for x in `seq 0 400`; do node bin/count-o-clock.js --hoursago $x ; done
+```
+
+this for example go back in the last 400 hours to recompute stats. It is necessary to run it every time config/trexstats.json get updated with new instruction
diff --git a/platforms/tktrex/backend/bin/README.md b/platforms/tktrex/backend/bin/README.md
deleted file mode 100644
index fcdc2acfe..000000000
--- a/platforms/tktrex/backend/bin/README.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-###How to use count-o-clock from crontab
-
-```
-1 * * * * cd platforms/tktrex/backend/; DEBUG=* node bin/count-o-clock.js --hoursago 1 2>&1| tee -a /tmp/count-o-clock.log
-```
-
-How to repeat executions that have been missed
-
-```
-cd platforms/tktrex/backend$
-$ for x in `seq 0 400`; do node bin/count-o-clock.js --hoursago $x ; done
-```
-
-this for example go back in the last 400 hours to recompute stats. It is necessary to run it every time config/trexstats.json get updated with new instruction
diff --git a/platforms/tktrex/backend/package.json b/platforms/tktrex/backend/package.json
index 81c399c84..63bc0162a 100644
--- a/platforms/tktrex/backend/package.json
+++ b/platforms/tktrex/backend/package.json
@@ -59,10 +59,17 @@
"eslint": "^8.25.0",
"ts-node": "^10.9.1",
"ts-node-dev": "^2.0.0",
+ "typedoc": "^0.23.23",
"typescript": "^4.8.4"
},
"_moduleAliases": {
"@shared": "../../../packages/shared/build",
"@tktrex/shared": "../shared/build"
+ },
+ "typedoc": {
+ "entryPoint": "./bin/server.ts",
+ "readmeFile": "./README.md",
+ "displayName": "TK TrEx - Backend",
+ "tsconfig": "./tsconfig.json"
}
}
diff --git a/platforms/tktrex/docs/package.json b/platforms/tktrex/docs/package.json
index 14eb501c2..0ee74db05 100644
--- a/platforms/tktrex/docs/package.json
+++ b/platforms/tktrex/docs/package.json
@@ -15,16 +15,16 @@
"typecheck": "tsc"
},
"dependencies": {
- "@docusaurus/core": "2.1.0",
- "@docusaurus/preset-classic": "2.1.0",
- "@mdx-js/react": "^1.6.21",
+ "@docusaurus/core": "2.2.0",
+ "@docusaurus/preset-classic": "2.2.0",
+ "@mdx-js/react": "^1.6.22",
"clsx": "^1.1.1",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2"
},
"devDependencies": {
- "@docusaurus/module-type-aliases": "2.1.0",
+ "@docusaurus/module-type-aliases": "2.2.0",
"@tsconfig/docusaurus": "^1.0.6",
"typescript": "^4.8.4"
},
diff --git a/platforms/tktrex/docs/sidebars.js b/platforms/tktrex/docs/sidebars.js
index 54ba60940..f6fffeb5e 100644
--- a/platforms/tktrex/docs/sidebars.js
+++ b/platforms/tktrex/docs/sidebars.js
@@ -15,17 +15,20 @@
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
-
// But you can create a sidebar manually
- /*
- tutorialSidebar: [
+
+ '@tktrex/shared': [
+ {
+ type: 'autogenerated',
+ dirName: 'typedoc/shared',
+ },
+ ],
+ '@tktrex/backend': [
{
- type: 'category',
- label: 'Tutorial',
- items: ['hello'],
+ type: 'autogenerated',
+ dirName: 'typedoc/backend',
},
],
- */
};
module.exports = sidebars;
diff --git a/platforms/tktrex/extension/__tests__/app.spec.ts b/platforms/tktrex/extension/__tests__/app.spec.ts
index 595f66cdc..4db77274c 100644
--- a/platforms/tktrex/extension/__tests__/app.spec.ts
+++ b/platforms/tktrex/extension/__tests__/app.spec.ts
@@ -254,7 +254,7 @@ describe('TK App', () => {
// video handler should be invoked as the url includes `watch`
const { handle: _handle, ...videoOpts } = videoMatcher;
- expect(handleVideoSpy).toHaveBeenCalledTimes(3);
+ expect(handleVideoSpy).toHaveBeenCalledTimes(4);
expect(handleSearchSpy).toHaveBeenCalledTimes(48);
expect(hubDispatchSpy).toHaveBeenCalledTimes(2);
diff --git a/platforms/tktrex/extension/jest.config.js b/platforms/tktrex/extension/jest.config.js
index 4292374e3..ef24a52a7 100644
--- a/platforms/tktrex/extension/jest.config.js
+++ b/platforms/tktrex/extension/jest.config.js
@@ -9,7 +9,7 @@ const tsPaths = pathsToModuleNameMapper(tsConfig.compilerOptions.paths, {
const moduleNameMapper = {
...tsPaths,
'\\.(svg|ttf)$': '/__mocks__/fileMock.js',
- '\\.(css)$': '/__mocks__/styleMock.js',
+ '\\.(css)$': '../../../__mocks__/styleMock.js',
};
/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
diff --git a/platforms/tktrex/extension/package.json b/platforms/tktrex/extension/package.json
index 0461e983b..06c04e078 100644
--- a/platforms/tktrex/extension/package.json
+++ b/platforms/tktrex/extension/package.json
@@ -44,6 +44,12 @@
"jest-environment-jsdom-global": "^3.1.2",
"jest-fetch-mock": "^3.0.3",
"typescript": "^4.8.4",
- "webpack": "^5.74.0"
+ "webpack": "^5.75.0"
+ },
+ "typedoc": {
+ "entryPoint": "./src/app/index.ts",
+ "readmeFile": "./README.md",
+ "displayName": "TK TrEx - Extension",
+ "tsconfig": "./tsconfig.json"
}
}
diff --git a/platforms/tktrex/extension/src/app/app.ts b/platforms/tktrex/extension/src/app/app.ts
index 6302fd7c3..35654121e 100644
--- a/platforms/tktrex/extension/src/app/app.ts
+++ b/platforms/tktrex/extension/src/app/app.ts
@@ -10,7 +10,7 @@ import { HTMLSize } from '@shared/extension/utils/HTMLSize.utils';
import _ from 'lodash';
import tkHub from './hub';
import { INTERCEPTOR_CONTAINER_ID } from '../interceptor/constants';
-import { addAppUI } from './components';
+import { addTKAppUI } from './components';
export const appLog = log.extend('app');
const searchSize = HTMLSize();
@@ -25,9 +25,7 @@ export function tkTrexActions(remoteInfo: unknown): void {
appLog.info('initialize watchers, remoteInfo available:', remoteInfo);
// initialize ui
-
- const apiInterceptorUI = document.createElement('div');
- addAppUI(apiInterceptorUI);
+ addTKAppUI();
// initializeEmergencyButton();
diff --git a/platforms/tktrex/extension/src/app/components/APIInterceptedSnackbar.tsx b/platforms/tktrex/extension/src/app/components/APIInterceptedSnackbar.tsx
index 2479cf202..7d928e055 100644
--- a/platforms/tktrex/extension/src/app/components/APIInterceptedSnackbar.tsx
+++ b/platforms/tktrex/extension/src/app/components/APIInterceptedSnackbar.tsx
@@ -1,7 +1,6 @@
import Snackbar from '@mui/material/Snackbar';
-import tkHub from '../hub';
-import _ from 'lodash';
import * as React from 'react';
+import tkHub from '../hub';
export const APIInterceptedSnackbar: React.FC = () => {
// const [show, setShow] = React.useState(false);
@@ -10,15 +9,12 @@ export const APIInterceptedSnackbar: React.FC = () => {
});
React.useEffect(() => {
- tkHub.on(
- 'APIRequestEvent',
- _.debounce((e) => {
- const payload: any = e.payload;
- if (!data.intercepted.some((ee) => ee.id === payload.id)) {
- setData({ intercepted: [...data.intercepted, payload] });
- }
- }, 400),
- );
+ tkHub.on('APIRequestEvent', (e) => {
+ const payload: any = e.payload;
+ if (!data.intercepted.some((ee) => ee.id === payload.id)) {
+ setData((data) => ({ intercepted: [...data.intercepted, payload] }));
+ }
+ });
}, [data.intercepted]);
const handleDump = (): void => {
diff --git a/platforms/tktrex/extension/src/app/components/SigiStateSnackbar.tsx b/platforms/tktrex/extension/src/app/components/SigiStateSnackbar.tsx
index 70965891e..a34238348 100644
--- a/platforms/tktrex/extension/src/app/components/SigiStateSnackbar.tsx
+++ b/platforms/tktrex/extension/src/app/components/SigiStateSnackbar.tsx
@@ -1,20 +1,17 @@
-import tkHub from '../hub';
-import * as React from 'react';
import { Snackbar } from '@material-ui/core';
-import _ from 'lodash';
+import * as React from 'react';
+import tkHub from '../hub';
export const SigiStateSnackbar: React.FC = () => {
// const [show, setShow] = React.useState(false);
const [data, setData] = React.useState([]);
React.useEffect(() => {
- tkHub.on(
- 'SigiState',
- _.debounce((e) => {
- const payload: any = e.payload;
- setData([...data, payload]);
- }, 400),
- );
+ tkHub.on('SigiState', (e) => {
+ const payload: any = e.payload;
+
+ setData((data) => [...data, payload]);
+ });
}, [data]);
const handleDump = (): void => {
diff --git a/platforms/tktrex/extension/src/app/components/index.tsx b/platforms/tktrex/extension/src/app/components/index.tsx
index b73dce6cb..6295ca87a 100644
--- a/platforms/tktrex/extension/src/app/components/index.tsx
+++ b/platforms/tktrex/extension/src/app/components/index.tsx
@@ -1,25 +1,15 @@
import { Box } from '@material-ui/core';
import * as React from 'react';
-import * as ReactDOM from 'react-dom';
import { APIInterceptedSnackbar } from './APIInterceptedSnackbar';
import { SigiStateSnackbar } from './SigiStateSnackbar';
-
-export const addAppUI = (node: Element): void => {
- if (document.body.contains(node)) {
- ReactDOM.unmountComponentAtNode(node);
- }
-
- node.id = 'tktrex-app-ui';
-
- document.body.append(node);
-
- ReactDOM.render(
-
-
-
-
-
- ,
- node,
+import { addPageUI } from '@shared/extension/ui';
+
+export const addTKAppUI = (): void => {
+ return addPageUI(
+ 'tktrex-app-ui',
+
+
+
+ ,
);
};
diff --git a/platforms/tktrex/extension/src/app/hub/index.ts b/platforms/tktrex/extension/src/app/hub/index.ts
index c84eb93c9..e8fee1115 100644
--- a/platforms/tktrex/extension/src/app/hub/index.ts
+++ b/platforms/tktrex/extension/src/app/hub/index.ts
@@ -52,14 +52,20 @@ function sync(hub: Hub, config: UserSettings): void {
userId: 'local',
},
(response) => {
- hub.dispatch({
- type: 'SyncResponse',
- payload: response,
- });
+ if (response.type === 'Error') {
+ hub.dispatch({
+ type: 'ErrorEvent',
+ payload: response.error,
+ });
+ } else {
+ state.content = [];
+ hub.dispatch({
+ type: 'SyncResponse',
+ payload: response,
+ });
+ }
},
);
-
- state.content = [];
}
}
diff --git a/platforms/tktrex/extension/src/app/index.ts b/platforms/tktrex/extension/src/app/index.ts
index f75498299..907d38305 100644
--- a/platforms/tktrex/extension/src/app/index.ts
+++ b/platforms/tktrex/extension/src/app/index.ts
@@ -22,4 +22,9 @@ void boot({
onLocationChange,
},
onAuthenticated: tkTrexActions,
+ ui: {
+ common: {
+ errors: true,
+ },
+ },
});
diff --git a/platforms/tktrex/extension/src/popup.tsx b/platforms/tktrex/extension/src/popup.tsx
index ba7b9feb3..5b0dde2aa 100644
--- a/platforms/tktrex/extension/src/popup.tsx
+++ b/platforms/tktrex/extension/src/popup.tsx
@@ -6,11 +6,13 @@ import {
AccountBox as AccountBoxIcon,
} from '@material-ui/icons';
import * as React from 'react';
+import hub from './app/hub';
renderPopup({
platform: 'TikTok',
platformURL: 'https://tiktok.com',
logo: '/tktrex-logo.png',
+ hub,
settings: {
enabled: {
researchTag: true,
diff --git a/platforms/tktrex/shared/package.json b/platforms/tktrex/shared/package.json
index 0d589afb2..036175f85 100644
--- a/platforms/tktrex/shared/package.json
+++ b/platforms/tktrex/shared/package.json
@@ -1,6 +1,7 @@
{
"name": "@tktrex/shared",
- "packageManager": "yarn@3.1.1",
+ "version": "2.8.1",
+ "packageManager": "yarn@3.2.3",
"scripts": {
"clean": "rm -rf ./build",
"lint": "eslint ./src",
@@ -35,5 +36,10 @@
"mongodb": "^4.12.1",
"ts-endpoint": "^2.0.0"
},
- "version": "2.8.1"
+ "typedoc": {
+ "entryPoint": "./src/index.ts",
+ "readmeFile": "./README.md",
+ "displayName": "TK TrEx - Shared",
+ "tsconfig": "./tsconfig.json"
+ }
}
diff --git a/platforms/tktrex/shared/src/index.ts b/platforms/tktrex/shared/src/index.ts
new file mode 100644
index 000000000..f10cd8388
--- /dev/null
+++ b/platforms/tktrex/shared/src/index.ts
@@ -0,0 +1,2 @@
+export * from './models';
+export * from './providers';
diff --git a/platforms/tktrex/shared/src/models/metadata/MetadataBase.ts b/platforms/tktrex/shared/src/models/metadata/MetadataBase.ts
index ea56f0293..4d113ed16 100644
--- a/platforms/tktrex/shared/src/models/metadata/MetadataBase.ts
+++ b/platforms/tktrex/shared/src/models/metadata/MetadataBase.ts
@@ -6,7 +6,7 @@ export const TKMetadataBase = t.type(
...MetadataBase.props,
timelineId: t.string,
},
- 'TKMetadataBase'
+ 'TKMetadataBase',
);
export type TKMetadataBase = t.TypeOf;
diff --git a/platforms/tktrex/shared/src/parser/metadata.ts b/platforms/tktrex/shared/src/parser/metadata.ts
index 8d0de5e5e..411f39389 100644
--- a/platforms/tktrex/shared/src/parser/metadata.ts
+++ b/platforms/tktrex/shared/src/parser/metadata.ts
@@ -16,7 +16,7 @@ export const toMetadata: BuildMetadataFn = (
clientTime: entry.source.html.clientTime,
href: entry.source.html.href,
thumbnails: [],
- blang: entry.source.html.blang ?? null
+ blang: entry.source.html.blang ?? null,
};
switch (entry.findings.nature.type) {
diff --git a/platforms/tktrex/shared/src/providers/index.ts b/platforms/tktrex/shared/src/providers/index.ts
new file mode 100644
index 000000000..51cfdacbf
--- /dev/null
+++ b/platforms/tktrex/shared/src/providers/index.ts
@@ -0,0 +1 @@
+export * from './api.provider';
diff --git a/platforms/ycai/studio/jest.config.js b/platforms/ycai/studio/jest.config.js
index ad2ed12f5..dd5d56e53 100644
--- a/platforms/ycai/studio/jest.config.js
+++ b/platforms/ycai/studio/jest.config.js
@@ -8,8 +8,8 @@ const tsPaths = pathsToModuleNameMapper(tsConfig.compilerOptions.paths, {
const moduleNameMapper = {
...tsPaths,
- '\\.(svg|ttf)$': '/__mocks__/fileMock.js',
- '\\.(css)$': '/__mocks__/styleMock.js',
+ '\\.(svg|ttf)$': '/../../../__mocks__/fileMock.js',
+ '\\.(css)$': '/../../../__mocks__/styleMock.js',
};
/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
diff --git a/platforms/ycai/studio/package.json b/platforms/ycai/studio/package.json
index 047f262fc..df4b611cd 100644
--- a/platforms/ycai/studio/package.json
+++ b/platforms/ycai/studio/package.json
@@ -58,11 +58,11 @@
"style-loader": "^3.3.1",
"svgdom": "^0.1.10",
"ts-jest": "^27.1.5",
- "ts-loader": "^9.4.1",
+ "ts-loader": "^9.4.2",
"ts-node": "^10.9.1",
"typescript": "^4.8.4",
- "webpack": "^5.74.0",
- "webpack-bundle-analyzer": "^4.6.1",
+ "webpack": "^5.75.0",
+ "webpack-bundle-analyzer": "^4.7.0",
"webpack-cli": "^4.10.0",
"webpack-dev-server": "^4.11.1"
},
diff --git a/platforms/yttrex/backend/config/settings.json b/platforms/yttrex/backend/config/settings.json
index 39672a513..a761a030d 100644
--- a/platforms/yttrex/backend/config/settings.json
+++ b/platforms/yttrex/backend/config/settings.json
@@ -1,19 +1,19 @@
{
"schema": {
- "supporters": "supporters",
- "htmls": "htmls",
- "metadata": "metadata",
- "stats": "trexstats",
- "leaves": "leaves",
- "errors": "errors",
- "answers": "answers",
- "recommendations": "recommendations",
- "ytvids": "ytvids",
- "experiments": "experiments2",
- "emails": "emails",
- "tokens": "tokens",
- "creators": "creators",
- "ads": "ads"
+ "supporters": "supporters",
+ "htmls": "htmls",
+ "metadata": "metadata",
+ "stats": "trexstats",
+ "leaves": "leaves",
+ "errors": "errors",
+ "answers": "answers",
+ "recommendations": "recommendations",
+ "ytvids": "ytvids",
+ "experiments": "experiments",
+ "emails": "emails",
+ "tokens": "tokens",
+ "creators": "creators",
+ "ads": "ads"
},
"mongoHost": "localhost",
"mongoPort": 27017,
diff --git a/platforms/yttrex/backend/config/trexstats.json b/platforms/yttrex/backend/config/trexstats.json
index db230ddf3..ed46c143c 100644
--- a/platforms/yttrex/backend/config/trexstats.json
+++ b/platforms/yttrex/backend/config/trexstats.json
@@ -151,7 +151,7 @@
},
{
"name": "experiments",
- "column": "experiments2",
+ "column": "experiments",
"timevar": "when",
"variables": [{ "name": "total", "selector": {} }]
},
diff --git a/platforms/yttrex/backend/package.json b/platforms/yttrex/backend/package.json
index 2e42f3d20..ff016a463 100644
--- a/platforms/yttrex/backend/package.json
+++ b/platforms/yttrex/backend/package.json
@@ -88,5 +88,11 @@
"_moduleAliases": {
"@shared": "../../../packages/shared/build",
"@yttrex/shared": "../shared/build"
+ },
+ "typedoc": {
+ "entryPoint": "./bin/server.ts",
+ "readmeFile": "./README.md",
+ "displayName": "YT TrEx - Backend",
+ "tsconfig": "./tsconfig.json"
}
}
diff --git a/platforms/yttrex/backend/routes/__tests__/experiments.e2e.ts b/platforms/yttrex/backend/routes/__tests__/experiments.e2e.ts
new file mode 100644
index 000000000..2ded3f764
--- /dev/null
+++ b/platforms/yttrex/backend/routes/__tests__/experiments.e2e.ts
@@ -0,0 +1,50 @@
+/* eslint-disable import/first */
+// mock curly module
+jest.mock('fetch-opengraph');
+
+// import test utils
+import { CommonStepArb } from '@shared/arbitraries/Step.arb';
+import { fc } from '@shared/test';
+import { GetTest, Test } from '../../tests/Test';
+
+describe('Experiments API', () => {
+ let test: Test;
+
+ beforeAll(async () => {
+ test = await GetTest();
+ });
+
+ afterAll(async () => {
+ await test.mongo.close();
+ });
+
+ describe('POST /v2/directives', () => {
+ it('fails with an incorrect experiment', async () => {
+ const { body } = await test.app
+ .post(`/api/v2/directives`)
+ .send({})
+ .expect(500);
+
+ expect(body).toMatchObject({});
+ });
+
+ it('succeeds with a correct experiment', async () => {
+ const steps = fc.sample(CommonStepArb, 10);
+
+ const { body } = await test.app
+ .post(`/api/v2/directives`)
+ .send(steps)
+ .expect(200);
+
+ expect(body).toMatchObject({
+ status: 'created',
+ });
+
+ await test.mongo3.deleteMany(
+ test.mongo,
+ test.config.get('schema').experiments,
+ { experimentId: body.experimentId }
+ );
+ });
+ });
+});
diff --git a/platforms/yttrex/backend/scripts/build-indexes.js b/platforms/yttrex/backend/scripts/build-indexes.js
index 89fcbcecb..9347ce51b 100644
--- a/platforms/yttrex/backend/scripts/build-indexes.js
+++ b/platforms/yttrex/backend/scripts/build-indexes.js
@@ -68,10 +68,10 @@ checkret('ads savingTime', ret);
ret = db.ads.createIndex({ id: 1 }, { unique: true });
checkret('ads id', ret);
-ret = db.experiments2.createIndex({ experimentId: -1, unique: true });
-checkret('experiments2 experimentId', ret);
-ret = db.experiments2.createIndex({ when: -1 });
-checkret('experiments2 when', ret);
+ret = db.experiments.createIndex({ experimentId: -1 }, { unique: true });
+checkret('experiments experimentId', ret);
+ret = db.experiments.createIndex({ when: -1 });
+checkret('experiments when', ret);
/* below this the collections are for youchoose */
ret = db.recommendations.createIndex({ urlId: 1 }, { unique: true });
diff --git a/platforms/yttrex/docs/docs/backend.md b/platforms/yttrex/docs/docs/backend.md
index 2cf45a6fe..96434e76d 100644
--- a/platforms/yttrex/docs/docs/backend.md
+++ b/platforms/yttrex/docs/docs/backend.md
@@ -1,6 +1,28 @@
---
-title: Backend
sidebar_position: 3
+title: Backend
+id: backend
---
-The `@tktrex/shared` module contains `endpoints`, `models` and other definitions needed by `@tktrex` ecosystem.
+import CodeBlock from '@theme/CodeBlock';
+
+**Build the backend for development:**
+
+- Start the mongoDB container:
+
+ docker-compose up -d mongodb
+
+
+- Start the mongo-indexes container:
+
+ docker-compose up -d mongo-yt-indexes
+
+- Start the backend:
+
+ yarn pm2 start platforms/yttrex/backend/ecosystem.dev.config.js
+
+
+- [Optional] Set the watcher for the logs:
+
+ yarn pm2 logs yt:backend:watch
+
diff --git a/platforms/yttrex/docs/docs/enviroment.mdx b/platforms/yttrex/docs/docs/enviroment.mdx
new file mode 100644
index 000000000..2e65b50c9
--- /dev/null
+++ b/platforms/yttrex/docs/docs/enviroment.mdx
@@ -0,0 +1,218 @@
+---
+sidebar_position: 4
+title: Enviroment Variables
+id: api
+---
+
+import style from './markdown-styles.module.css';
+
+Shared enviroment variables
+
+
+ API_ROOT
+
+ Points to the top level API URL.
+
+
Default:
+
+ -
+ Production:
+
+ https://youtube.tracking.exposed/api
+
+
+ -
+ Development:
+
+ http://localhost:9000/api
+
+
+
+
+
+
+ WEB_ROOT
+
+
+ Poins to the tracking exposed YT page.
+
+
Default:
+
+ -
+ Production:
+
+ https://youtube.tracking.exposed
+
+
+ -
+ Development:
+
+ http://localhost:1313
+
+
+
+
+
+
+ DATA_CONTRIBUTION_ENABLED
+
+ Dictates if the extension should send data to the server.
+
+
Default:
+
+ -
+ Production:
+
+ false
+
+
+ -
+ Development:
+
+ true
+
+
+
+
+
+ FLUSH_INTERVAL
+
+ How often the extension sends data to the server, measured in ms.
+
+
Default:
+
+ -
+ Production:
+
+ 10000
+
+
+ -
+ Development:
+
+ 4000
+
+
+
+
+
+ DEBUG
+
+ Allows you to toggle the debug output for different parts of your module as well as the module as a whole.
+
+
Default:
+
+ -
+ Production:
+
+ @trex\*
+
+
+ -
+ Development:
+
+ @trex\*
+
+
+
+
+
Development enviroment variables
+
+
+ BUNDLE_TARGET
+
+ Allows you to configure the extension output depending on the browser.
+
+
Default:
+
+ -
+ Development:
+
+ firefox
+
+
+
+
+
+ BUILD_TRANSPILE_ONLY
+
+ Avoids typescript type cheking on build.
+
+
Default:
+
+ -
+ Development:
+
+ true
+
+
+
+
+
+ NODE_ENV
+
+ Used by Express to alter its own default behavior.
+
+
Default:
+
+ -
+ Development:
+
+ development
+
+
+
+
+
Guardoni enviroment variables
+
+
+ PUBLIC_KEY
+
+ Guardoni Public Key
+
+
Default:
+
+ -
+
+ H7AsuUszehN4qKTj2GYYwNNzkJVqUQBRo2wgKevzeUwx
+
+
+
+
+
+ SECRET_KEY
+
+ Guardoni Secret Key
+
+
Default:
+
+ -
+
+ v6pyCC8TzKd1uq7LnGaLQDaZ4qmJwKCne7moXwr1EJthxne4sqBWPkHwqyH8QH5n9pNQGAGBeA9hZ1jwy4hUyeW
+
+
+
+
+
+