@saooti/octopus-sdk 42.0.0-beta → 42.0.0-beta3

package/dist/src/stores/FilterStore.d.ts

@@ -26,11 +26,12 @@ export declare const useFilterStore: import('pinia').StoreDefinition<"FilterStor
         organisationId?: string;
         rubriquageId?: number;
         rubriques: {
-            emissionCount?: number;
             name: string;
-            podcastCount?: number;
-            rubriquageId?: number;
             rubriqueId: number;
+            rubriquageId?: number;
+            emissionCount?: number;
+            podcastCount?: number;
+            annotations?: Record<string, string | number | boolean>;
             score?: number;
             organisationPrivacy?: string;
         }[];
@@ -42,11 +43,12 @@ export declare const useFilterStore: import('pinia').StoreDefinition<"FilterStor
         organisationId?: string;
         rubriquageId?: number;
         rubriques: {
-            emissionCount?: number;
             name: string;
-            podcastCount?: number;
-            rubriquageId?: number;
             rubriqueId: number;
+            rubriquageId?: number;
+            emissionCount?: number;
+            podcastCount?: number;
+            annotations?: Record<string, string | number | boolean>;
             score?: number;
             organisationPrivacy?: string;
         }[];
@@ -67,19 +69,21 @@ export declare const useFilterStore: import('pinia').StoreDefinition<"FilterStor
         nameRubrique: string;
     }[]>;
     filterRubriqueDisplay: import('../../node_modules/vue').Ref<{
-        emissionCount?: number;
         name: string;
-        podcastCount?: number;
-        rubriquageId?: number;
         rubriqueId: number;
+        rubriquageId?: number;
+        emissionCount?: number;
+        podcastCount?: number;
+        annotations?: Record<string, string | number | boolean>;
         score?: number;
         organisationPrivacy?: string;
     }[], Rubrique[] | {
-        emissionCount?: number;
         name: string;
-        podcastCount?: number;
-        rubriquageId?: number;
         rubriqueId: number;
+        rubriquageId?: number;
+        emissionCount?: number;
+        podcastCount?: number;
+        annotations?: Record<string, string | number | boolean>;
         score?: number;
         organisationPrivacy?: string;
     }[]>;
@@ -105,11 +109,12 @@ export declare const useFilterStore: import('pinia').StoreDefinition<"FilterStor
         organisationId?: string;
         rubriquageId?: number;
         rubriques: {
-            emissionCount?: number;
             name: string;
-            podcastCount?: number;
-            rubriquageId?: number;
             rubriqueId: number;
+            rubriquageId?: number;
+            emissionCount?: number;
+            podcastCount?: number;
+            annotations?: Record<string, string | number | boolean>;
             score?: number;
             organisationPrivacy?: string;
         }[];
@@ -121,11 +126,12 @@ export declare const useFilterStore: import('pinia').StoreDefinition<"FilterStor
         organisationId?: string;
         rubriquageId?: number;
         rubriques: {
-            emissionCount?: number;
             name: string;
-            podcastCount?: number;
-            rubriquageId?: number;
             rubriqueId: number;
+            rubriquageId?: number;
+            emissionCount?: number;
+            podcastCount?: number;
+            annotations?: Record<string, string | number | boolean>;
             score?: number;
             organisationPrivacy?: string;
         }[];
@@ -146,19 +152,21 @@ export declare const useFilterStore: import('pinia').StoreDefinition<"FilterStor
         nameRubrique: string;
     }[]>;
     filterRubriqueDisplay: import('../../node_modules/vue').Ref<{
-        emissionCount?: number;
         name: string;
-        podcastCount?: number;
-        rubriquageId?: number;
         rubriqueId: number;
+        rubriquageId?: number;
+        emissionCount?: number;
+        podcastCount?: number;
+        annotations?: Record<string, string | number | boolean>;
         score?: number;
         organisationPrivacy?: string;
     }[], Rubrique[] | {
-        emissionCount?: number;
         name: string;
-        podcastCount?: number;
-        rubriquageId?: number;
         rubriqueId: number;
+        rubriquageId?: number;
+        emissionCount?: number;
+        podcastCount?: number;
+        annotations?: Record<string, string | number | boolean>;
         score?: number;
         organisationPrivacy?: string;
     }[]>;
@@ -184,11 +192,12 @@ export declare const useFilterStore: import('pinia').StoreDefinition<"FilterStor
         organisationId?: string;
         rubriquageId?: number;
         rubriques: {
-            emissionCount?: number;
             name: string;
-            podcastCount?: number;
-            rubriquageId?: number;
             rubriqueId: number;
+            rubriquageId?: number;
+            emissionCount?: number;
+            podcastCount?: number;
+            annotations?: Record<string, string | number | boolean>;
             score?: number;
             organisationPrivacy?: string;
         }[];
@@ -200,11 +209,12 @@ export declare const useFilterStore: import('pinia').StoreDefinition<"FilterStor
         organisationId?: string;
         rubriquageId?: number;
         rubriques: {
-            emissionCount?: number;
             name: string;
-            podcastCount?: number;
-            rubriquageId?: number;
             rubriqueId: number;
+            rubriquageId?: number;
+            emissionCount?: number;
+            podcastCount?: number;
+            annotations?: Record<string, string | number | boolean>;
             score?: number;
             organisationPrivacy?: string;
         }[];
@@ -225,19 +235,21 @@ export declare const useFilterStore: import('pinia').StoreDefinition<"FilterStor
         nameRubrique: string;
     }[]>;
     filterRubriqueDisplay: import('../../node_modules/vue').Ref<{
-        emissionCount?: number;
         name: string;
-        podcastCount?: number;
-        rubriquageId?: number;
         rubriqueId: number;
+        rubriquageId?: number;
+        emissionCount?: number;
+        podcastCount?: number;
+        annotations?: Record<string, string | number | boolean>;
         score?: number;
         organisationPrivacy?: string;
     }[], Rubrique[] | {
-        emissionCount?: number;
         name: string;
-        podcastCount?: number;
-        rubriquageId?: number;
         rubriqueId: number;
+        rubriquageId?: number;
+        emissionCount?: number;
+        podcastCount?: number;
+        annotations?: Record<string, string | number | boolean>;
         score?: number;
         organisationPrivacy?: string;
     }[]>;

package/dist/src/stores/class/rubrique/rubrique.d.ts

@@ -1,9 +1,16 @@
 export interface Rubrique {
-    emissionCount?: number;
+    /** Name of the rubrique */
     name: string;
-    podcastCount?: number;
-    rubriquageId?: number;
+    /** ID of the rubrique */
     rubriqueId: number;
+    /** ID of the rubriquage this rubrique belongs to */
+    rubriquageId?: number;
+    /** Number of emissions in the rubrique */
+    emissionCount?: number;
+    /** Number of podcasts in the rubrique */
+    podcastCount?: number;
+    /** Custom properties defined on the rubrique */
+    annotations?: Record<string, string | number | boolean>;
     score?: number;
     organisationPrivacy?: string;
 }

package/eslint-config.d.ts

@@ -0,0 +1,3 @@
+import type { ConfigArray } from 'typescript-eslint';
+declare const config: ConfigArray;
+export default config;

package/eslint-config.mjs

@@ -0,0 +1,54 @@
+import eslint from '@eslint/js';
+import eslintPluginVue from 'eslint-plugin-vue';
+import globals from 'globals';
+import typescriptEslint from 'typescript-eslint';
+import stylistic from '@stylistic/eslint-plugin';
+
+export default typescriptEslint.config(
+  { ignores: ['*.d.ts', '**/coverage', '**/dist'] },
+  {
+    extends: [
+      eslint.configs.recommended,
+      ...typescriptEslint.configs.recommended,
+      ...eslintPluginVue.configs['flat/recommended'],
+    ],
+    plugins: {
+      '@stylistic': stylistic,
+    },
+    files: ['**/*.{ts,vue}'],
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: globals.browser,
+      parserOptions: {
+        parser: typescriptEslint.parser,
+      },
+    },
+    rules: {
+      // your rules
+      "curly": ['error'],
+
+      // Please don't use console statements and duplicated imports, TODOs are marked
+      "no-console": ['warn', { allow: ['warn', 'error'] }],
+      "no-warning-comments": ['warn'],
+      "no-duplicate-imports": ['warn'],
+
+      // Prevent errors when testing on refs (instead of value of ref)
+      "vue/no-ref-as-operand": ['error'],
+
+      // Indentation
+      "@stylistic/indent": ['warn', 4, { "SwitchCase": 0 }],
+      "vue/html-indent": ['warn', 4],
+      "vue/script-indent": ['warn', 4],
+      "@stylistic/no-mixed-spaces-and-tabs": ["error", "smart-tabs"],
+
+      // Number of attributes per line (increase because sometimes two is not a lot)
+      "vue/max-attributes-per-line": ['warn', { singleline: 2 } ],
+
+      // Disable default values required for props
+      "vue/require-default-prop": ['off'],
+
+      "@typescript-eslint/no-unused-vars": "warn"
+    }
+  }
+);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saooti/octopus-sdk",
-  "version": "42.0.0-beta",
+  "version": "42.0.0-beta3",
   "private": false,
   "description": "Javascript SDK for using octopus",
   "author": "Saooti",
@@ -119,10 +119,15 @@
     "./eslint-config": {
       "types": "./eslint-config.d.ts",
       "default": "./eslint-config.mjs"
-    }
+    },
+    "./fonts/style.css": "./public/css/fonts/localFonts/style.css"
   },
   "files": [
     "dist",
-    "src"
+    "src",
+    "tests",
+    "eslint-config.mjs",
+    "eslint-config.d.ts",
+    "public/css/fonts/localFonts"
   ]
 }

package/public/css/fonts/localFonts/style.css

@@ -0,0 +1,72 @@
+@font-face {
+  font-family: "Montserrat";
+  src: local("Montserrat"),
+    url("./Montserrat-Regular.woff2") format('woff2'),
+    url("./Montserrat-Regular.ttf") format("truetype");
+  font-weight: 400;
+  font-style: normal;
+  font-display: swap;
+}
+@font-face {
+  font-family: "Montserrat";
+  src: local("Montserrat"),
+    url("./Montserrat-Medium.woff2") format('woff2'),
+    url("./Montserrat-Medium.ttf") format("truetype");
+  font-weight: 500;
+  font-style: normal;
+  font-display: swap;
+}
+@font-face {
+  font-family: "Montserrat";
+  src: local("Montserrat"),
+    url("./Montserrat-SemiBold.woff2") format('woff2'),
+    url("./Montserrat-SemiBold.ttf") format("truetype");
+  font-weight: 600;
+  font-style: normal;
+  font-display: swap;
+}
+@font-face {
+  font-family: "Montserrat";
+  src: local("Montserrat"),
+    url("./Montserrat-Bold.woff2") format('woff2'),
+    url("./Montserrat-Bold.ttf") format("truetype");
+  font-weight: 700;
+  font-style: normal;
+  font-display: swap;
+}
+@font-face {
+  font-family: "Cookie";
+  src: local("Cookie"),
+    url("./Cookie-Regular.woff2") format('woff2'),
+    url("./Cookie-Regular.ttf") format("truetype");
+  font-weight: 400;
+  font-style: normal;
+  font-display: swap;
+}
+@font-face {
+  font-family: "Comfortaa";
+  src: local("Comfortaa"),
+    url("./Comfortaa-Regular.woff2") format('woff2'),
+    url("./Comfortaa-Regular.ttf") format("truetype");
+  font-weight: 400;
+  font-style: normal;
+  font-display: swap;
+}
+@font-face {
+  font-family: "Roboto";
+  src: local("Roboto"),
+    url("./Roboto-Regular.woff2") format('woff2'),
+    url("./Roboto-Regular.ttf") format("truetype");
+  font-weight: 400;
+  font-style: normal;
+  font-display: swap;
+}
+@font-face {
+  font-family: "Roboto Slab";
+  src: local("Roboto Slab"),
+    url("./RobotoSlab-Regular.woff2") format('woff2'),
+    url("./RobotoSlab-Regular.ttf") format("truetype");
+  font-weight: 400;
+  font-style: normal;
+  font-display: swap;
+}

package/tests/api/podcastApi.spec.ts

@@ -0,0 +1,43 @@
+import { describe, expect, it, vi, beforeEach } from 'vitest';
+
+vi.mock('../../src/api/classicApi', () => ({
+    default: {
+        fetchData: vi.fn()
+    }
+}));
+
+import classicApi from '../../src/api/classicApi';
+import { podcastApi } from '../../src/api/podcastApi';
+
+const baseOptions = { organisationId: ['org-1'] };
+
+describe('podcastApi', () => {
+    describe('count', () => {
+        beforeEach(() => {
+            vi.mocked(classicApi.fetchData).mockResolvedValue({ count: 42, result: [], sort: null });
+        });
+
+        it('returns the count from search results', async () => {
+            const result = await podcastApi.count(baseOptions);
+            expect(result).toBe(42);
+        });
+
+        it('calls search with size 0', async () => {
+            await podcastApi.count(baseOptions);
+            expect(classicApi.fetchData).toHaveBeenCalledWith(
+                expect.objectContaining({
+                    parameters: expect.objectContaining({ size: 0 })
+                })
+            );
+        });
+
+        it('forwards other options to search', async () => {
+            await podcastApi.count({ ...baseOptions, emissionId: 5 });
+            expect(classicApi.fetchData).toHaveBeenCalledWith(
+                expect.objectContaining({
+                    parameters: expect.objectContaining({ organisationId: ['org-1'], emissionId: 5 })
+                })
+            );
+        });
+    });
+});

package/tests/api/transcriptionApi.spec.ts

@@ -0,0 +1,58 @@
+import { describe, expect, it, vi, beforeEach } from 'vitest';
+
+vi.mock('../../src/api/classicApi', () => ({
+    default: {
+        fetchData: vi.fn()
+    }
+}));
+
+import classicApi from '../../src/api/classicApi';
+import { transcriptionApi } from '../../src/api/transcriptionApi';
+import { ModuleApi } from '../../src/api/apiConnection';
+
+describe('transcriptionApi', () => {
+    beforeEach(() => {
+        vi.mocked(classicApi.fetchData).mockResolvedValue('');
+    });
+
+    describe('getTranslations', () => {
+        it('calls the SPEECHTOTEXT api with the correct path', async () => {
+            await transcriptionApi.getTranslations(42);
+            expect(classicApi.fetchData).toHaveBeenCalledWith({
+                api: ModuleApi.SPEECHTOTEXT,
+                path: 'transcription/42/languages',
+            });
+        });
+    });
+
+    describe('getTranslation', () => {
+        it('calls the SPEECHTOTEXT api with the correct path', async () => {
+            await transcriptionApi.getTranslation(42, 'en');
+            expect(classicApi.fetchData).toHaveBeenCalledWith({
+                api: ModuleApi.SPEECHTOTEXT,
+                path: 'transcription/42/languages/en/srt',
+            });
+        });
+
+        it.each([
+            [true, 'true'],
+            [false, 'false'],
+        ])('appends mayCreateIfNotExists=%s to path when mayCreate is %s', async (mayCreate, suffix) => {
+            await transcriptionApi.getTranslation(42, 'en', mayCreate);
+            expect(classicApi.fetchData).toHaveBeenCalledWith({
+                api: ModuleApi.SPEECHTOTEXT,
+                path: `transcription/42/languages/en/srt?mayCreateIfNotExists=${suffix}`,
+            });
+        });
+    });
+
+    describe('getRawTranscription', () => {
+        it('calls the SPEECHTOTEXT api with the correct path', async () => {
+            await transcriptionApi.getRawTranscription(42);
+            expect(classicApi.fetchData).toHaveBeenCalledWith({
+                api: ModuleApi.SPEECHTOTEXT,
+                path: 'transcription/text/42',
+            });
+        });
+    });
+});