@glissandoo/lib 1.15.0 → 1.15.1

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/README.md

@@ -0,0 +1,70 @@
+# Glissandoo Library
+
+## What is this repository for?
+
+-   This repo contains a common model codebase that all Glissandoo projects can use.
+
+## Configuration
+
+-   This project should work with any Node.js version >= 12 and uses NPM to manage dependencies.
+-   To install Node.js, we recommend using NVM, which is a Node.js version manager, and can be installed with the following command:
+
+    ```bash
+    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
+    ```
+
+-   Once installed, restart your terminal and you will be able to use the following command to install the desired Node.js version:
+
+    ```bash
+    nvm install {version}
+    ```
+
+-   To activate a certain Node.js version, you can use the following command:
+
+    ```bash
+    nvm use {version}
+    ```
+
+-   Then, install dependencies with the following command:
+
+    ```bash
+    npm install
+    ```
+
+## Developing locally
+
+### 0. (Optional) Create a VS Code workspace including lib:
+
+-   Open your existing project with VS Code. Then, in the upper left menu, go to File > Add Folder to Workspace, and choose the lib repo folder.
+
+-   Then, in the same menu as before, go to File > Save Workspace As... and save your workspace wherever you like.
+
+-   Now, you will be able to work in both your current project and the lib repo in the same workspace.
+
+### 1. NPM-Link lib to your project:
+
+-   There is a way to link your local lib project to your current project, so any changes made to your local lib repo will automatically be reflected in your current project.
+
+-   To do this, open a terminal and go to the lib repo folder. Then, run the following command:
+
+    ```bash
+    npm run link
+    ```
+
+    This will create a symlink to your lib repo globally.
+
+-   Now, to tell your project to use the symlink, go to your project folder and run the following command:
+
+    ```bash
+    npm link @glissandoo/lib
+    ```
+
+-   Now, your project will use the ts-compiled folder of the lib repo as its dependency, but there is one more step left.
+
+-   Since we use TypeScript, we would need to compile lib for every change we made to it, but we can automate this process by opening a terminal, going into the lib repo folder and keeping the following command running:
+
+    ```bash
+    npm run build:watch
+    ```
+
+    This will compile lib for every change you make to it, so that changes automatically get reflected in your current project.

package/{functions → lib/functions}/groupRepertory.d.ts

@@ -1,24 +1,17 @@
 import { InstrumentId } from '../helpers/instruments';
-import { GroupRepertoryTagAlgoliaData } from '../models/Group/Repertory/types';
+import { GroupRepertoireFile, GroupRepertoireVisibility, GroupRepertoryTagAlgoliaData } from '../models/Group/Repertory/types';
 import { ThemeMediaType } from '../models/Repertory/types';
 export declare namespace GroupRepertoryFbFunctionsTypes {
     interface GroupRepertoryPublishEditParams {
         themeId: string;
         groupId: string;
         title: string;
-        scoresByInstruments: boolean;
-        isFileIdentify: boolean;
-        mainFilePath: string | null;
         compositor: string | null;
         media: ThemeMediaType | null;
         tags: string[] | null;
         tagsAlgolia: GroupRepertoryTagAlgoliaData[] | null;
-        audios: string[] | null;
-        instruments: Array<{
-            id: InstrumentId;
-            pages: number[];
-            filesPath: string[];
-        }> | null;
+        files: Record<string, GroupRepertoireFile>;
+        visibility: GroupRepertoireVisibility;
     }
     export type PublishParams = GroupRepertoryPublishEditParams;
     export type PublishResult = void;

package/{helpers → lib/helpers}/utils.d.ts

@@ -4,3 +4,6 @@ import { Descendant } from './slate';
 export declare const replaceVarsBrackets: (string: string, values: MetaNotificationData) => string;
 export declare const replaceKeysNotification: (string: string, values: MetaNotificationData, lang: LanguagesTypes) => string;
 export declare const serializeSlateBlock: (nodes: Descendant[]) => string;
+export declare const objToArray: <T>(obj: Record<string, T>) => (T & {
+    id: string;
+})[];

package/{helpers → lib/helpers}/utils.js

@@ -14,7 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeSlateBlock = exports.replaceKeysNotification = exports.replaceVarsBrackets = void 0;
+exports.objToArray = exports.serializeSlateBlock = exports.replaceKeysNotification = exports.replaceVarsBrackets = void 0;
 const date_fns_1 = require("date-fns");
 const date_fns_tz_1 = require("date-fns-tz");
 const get_1 = __importDefault(require("lodash/get"));
@@ -96,3 +96,7 @@ const serializeSlateBlock = (nodes) => {
         .join(' ');
 };
 exports.serializeSlateBlock = serializeSlateBlock;
+const objToArray = (obj) => {
+    return Object.keys(obj).map((key) => (Object.assign(Object.assign({}, obj[key]), { id: key })));
+};
+exports.objToArray = objToArray;

package/{models → lib/models}/Group/Repertory/index.d.ts

@@ -3,18 +3,26 @@ import { InstrumentId } from '../../../helpers/instruments';
 import { LanguagesTypes } from '../../../lang';
 import EventoTiny from '../../Evento/tiny';
 import Theme from '../../Repertory/basic';
-import { AGroupRepertoryClaim, GroupRepertoryData } from './types';
+import { AGroupRepertoryClaim, GroupRepertoireSectionId as SectionId, GroupRepertoireVisibility, GroupRepertoryData } from './types';
 export default class GroupRepertory extends Theme<GroupRepertoryData> {
     private lang;
     constructor(doc: firestore.DocumentSnapshot, lang?: LanguagesTypes);
     get groupId(): string;
     get tagsAlgolia(): import("./types").GroupRepertoryTagAlgoliaData[];
+    /** @deprecated use sections */
     get instruments(): {
         filesPath: string[] | undefined;
         id: InstrumentId;
         pages: number[];
     }[];
+    get files(): Record<string, import("./types").GroupRepertoireFile>;
+    get fileList(): (import("./types").GroupRepertoireFile & {
+        id: string;
+    })[];
+    get sections(): SectionId[];
+    /** @deprecated use sections */
     get mainFilePath(): string | null;
+    get visibility(): GroupRepertoireVisibility;
     get votes(): Record<string, number>;
     get votesCount(): number;
     voteByUserId(userId: string): number | null;
@@ -26,32 +34,27 @@ export default class GroupRepertory extends Theme<GroupRepertoryData> {
     get nextEvents(): EventoTiny[];
     /** @deprecated use getNextEvent */
     get nextEvent(): EventoTiny | null;
+    /** @deprecated use sections */
     get scoresByInstruments(): boolean;
     get editedAt(): firestore.Timestamp | null;
     get createdAt(): firestore.Timestamp;
+    /** @deprecated use sections */
     get audios(): string[];
+    /** @deprecated use sections */
     get identifyAt(): firestore.Timestamp | null;
+    /** @deprecated use sections */
     get isIdentify(): boolean;
     get isActive(): boolean;
     get thumbnailURL(): string | null;
     get ownerId(): string;
     get lastEventDatetime(): firestore.Timestamp | null;
-    /** @deprecated  */
-    get viewers(): Record<string, import("./types").GroupRepertoryViewer>;
-    /** @deprecated  */
-    get listViewers(): (import("./types").GroupRepertoryViewer & {
-        id: string;
-    })[];
-    /** @deprecated */
-    get totalViews(): number;
     get claims(): Record<string, Record<string, import("./types").GroupRepertoryClaimType>>;
     get claimsList(): AGroupRepertoryClaim[];
     claimsByInstrument(instrumentId: string): Record<string, import("./types").GroupRepertoryClaimType>;
     getPlayersByInstrumentClaimed(instrumentId: string, onlyNoNotified?: boolean): string[];
     isInstrumentClaimed(instrumentId: string): boolean;
     isInstrumentClaimedByPlayer(instrumentId: InstrumentId, userId: string): boolean;
-    /** @deprecated */
-    getViewer(userId: string): import("./types").GroupRepertoryViewer | null;
+    /** @deprecated use sections */
     getInstrument(id: string): {
         filesPath: string[] | undefined;
         id: InstrumentId;

package/{models → lib/models}/Group/Repertory/index.js

@@ -5,11 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const endOfDay_1 = __importDefault(require("date-fns/endOfDay"));
 const isFuture_1 = __importDefault(require("date-fns/isFuture"));
+const lodash_1 = require("lodash");
 const get_1 = __importDefault(require("lodash/get"));
 const orderBy_1 = __importDefault(require("lodash/orderBy"));
+const utils_1 = require("../../../helpers/utils");
 const lang_1 = require("../../../lang");
 const tiny_1 = __importDefault(require("../../Evento/tiny"));
 const basic_1 = __importDefault(require("../../Repertory/basic"));
+const types_1 = require("./types");
 class GroupRepertory extends basic_1.default {
     constructor(doc, lang = lang_1.defaultLocale) {
         super(doc);
@@ -22,13 +25,27 @@ class GroupRepertory extends basic_1.default {
     get tagsAlgolia() {
         return this.data.tagsAlgolia || [];
     }
+    /** @deprecated use sections */
     get instruments() {
         const instruments = this.data.instruments || [];
         return instruments.map((instrument) => (Object.assign(Object.assign({}, instrument), { filesPath: instrument.filesPath })));
     }
+    get files() {
+        return this.data.files || {};
+    }
+    get fileList() {
+        return utils_1.objToArray(this.files);
+    }
+    get sections() {
+        return lodash_1.uniq(lodash_1.flatten(this.fileList.map((file) => Object.keys(file.sections))));
+    }
+    /** @deprecated use sections */
     get mainFilePath() {
         return this.data.mainFilePath;
     }
+    get visibility() {
+        return this.data.visibility || types_1.GroupRepertoireVisibility.ByEvent;
+    }
     get votes() {
         return this.data.votes || {};
     }
@@ -64,6 +81,7 @@ class GroupRepertory extends basic_1.default {
         }
         return this.nextEvents[this.nextEvents.length - 1];
     }
+    /** @deprecated use sections */
     get scoresByInstruments() {
         return this.data.scoresByInstruments || false;
     }
@@ -73,12 +91,15 @@ class GroupRepertory extends basic_1.default {
     get createdAt() {
         return this.data.createdAt;
     }
+    /** @deprecated use sections */
     get audios() {
         return this.data.audios || [];
     }
+    /** @deprecated use sections */
     get identifyAt() {
         return this.data.identifyAt;
     }
+    /** @deprecated use sections */
     get isIdentify() {
         return this.identifyAt !== null || this.identifyAt !== undefined;
     }
@@ -94,20 +115,6 @@ class GroupRepertory extends basic_1.default {
     get lastEventDatetime() {
         return this.data.lastEventDatetime || null;
     }
-    /** @deprecated  */
-    get viewers() {
-        return this.data.viewers || {};
-    }
-    /** @deprecated  */
-    get listViewers() {
-        return Object.keys(this.viewers).map((userId) => Object.assign(this.viewers[userId], { id: userId }));
-    }
-    /** @deprecated */
-    get totalViews() {
-        return this.listViewers
-            .map((viewer) => viewer.count || 0)
-            .reduce((acc, current) => acc + current);
-    }
     get claims() {
         return this.data.claims || {};
     }
@@ -142,10 +149,7 @@ class GroupRepertory extends basic_1.default {
         }
         return userId in this.claims[instrumentId];
     }
-    /** @deprecated */
-    getViewer(userId) {
-        return userId in this.viewers ? this.viewers[userId] : null;
-    }
+    /** @deprecated use sections */
     getInstrument(id) {
         return this.instruments.find((i) => i.id === id);
     }

package/{models → lib/models}/Group/Repertory/types.d.ts

@@ -2,6 +2,10 @@ import { DocumentReference, Timestamp } from '@google-cloud/firestore';
 import { InstrumentId } from '../../../helpers/instruments';
 import { EventTinyData } from '../../Evento/types';
 import { ThemeBasicData } from '../../Repertory/types';
+export declare enum GroupRepertoireVisibility {
+    Always = "always",
+    ByEvent = "byEvent"
+}
 export interface AGroupRepertoryClaim extends GroupRepertoryClaimType {
     userId: string;
     instrumentId: InstrumentId;
@@ -24,21 +28,46 @@ export interface GroupRepertoryInstrumentItemData {
     pages: number[];
     filesPath?: string[];
 }
+export declare type GroupRepertoireSectionId = InstrumentId | 'all';
+export interface GroupRepertoireScoreFilePage {
+    tags: string[];
+}
+export interface AGroupRepertoireScoreFilePage extends GroupRepertoireScoreFilePage {
+    id: GroupRepertoireSectionId;
+}
+export interface GroupRepertoireFileSections {
+    tags?: string[];
+    pages?: Record<number, GroupRepertoireScoreFilePage>;
+}
+export interface GroupRepertoireFile {
+    readonly path: string;
+    readonly filetype: string;
+    readonly uploadedAt: number;
+    readonly pageCount: number | null;
+    readonly isEncrypted: boolean;
+    identifyAt: number | null;
+    sections: Partial<Record<GroupRepertoireSectionId, GroupRepertoireFileSections>>;
+}
 export interface GroupRepertoryData extends ThemeBasicData {
     events: string[];
     eventsTL: Record<string, EventTinyData>;
     tagsAlgolia: GroupRepertoryTagAlgoliaData[];
+    /** @deprecated  */
     mainFilePath: string | null;
+    /** @deprecated  */
     scoresByInstruments: boolean;
+    /** @deprecated  */
     instruments: GroupRepertoryInstrumentItemData[];
-    votes: Record<string, number>;
+    /** @deprecated  */
     audios: string[];
-    thumbnailURL: string | null;
+    /** @deprecated  */
     identifyAt: Timestamp | null;
+    files: Record<string, GroupRepertoireFile>;
+    votes: Record<string, number>;
+    thumbnailURL: string | null;
     editedAt: Timestamp | null;
+    visibility: GroupRepertoireVisibility;
     lastEventDatetime: Timestamp | null;
-    /** @deprecated  */
-    viewers: Record<string, GroupRepertoryViewer>;
     claims: Record<string, Record<string, GroupRepertoryClaimType>>;
     clonedFrom: DocumentReference | null;
     readonly owner: DocumentReference;

package/lib/models/Group/Repertory/types.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupRepertoireVisibility = void 0;
+var GroupRepertoireVisibility;
+(function (GroupRepertoireVisibility) {
+    GroupRepertoireVisibility["Always"] = "always";
+    GroupRepertoireVisibility["ByEvent"] = "byEvent";
+})(GroupRepertoireVisibility = exports.GroupRepertoireVisibility || (exports.GroupRepertoireVisibility = {}));

package/{models → lib/models}/Group/index.d.ts

@@ -27,9 +27,13 @@ export default class Group extends GroupBasic<GroupData> {
     get communicationCount(): number;
     get country(): string;
     get activePlayers(): string[];
-    get playersList(): (import("../Player/types").PlayerBasicData & {
+    get playersList(): {
         id: string;
-    })[];
+        mainInstrument: import("../../helpers/instruments").InstrumentId;
+        username: string;
+        displayName: string;
+        photoURL: string;
+    }[];
     get isActive(): boolean;
     get isDeleted(): boolean;
     get intercomId(): string | null;
@@ -37,9 +41,9 @@ export default class Group extends GroupBasic<GroupData> {
     get socialNetworks(): Record<SocialNetwork, string | null>;
     getSocialNetworkUrl(id: SocialNetwork): string | null;
     get config(): Record<import("./types").GroupConfig, boolean>;
-    get templates(): Record<string, import("./types").GroupTemplateData>;
     get status(): GroupStatus;
     get planId(): PlansGroup;
+    get templates(): Record<string, import("./types").GroupTemplateData>;
     get templatesList(): (import("./types").GroupTemplateData & {
         id: string;
     })[];
@@ -57,4 +61,8 @@ export default class Group extends GroupBasic<GroupData> {
         id: string;
     })[];
     get firstAnswerAt(): FirebaseFirestore.Timestamp | null;
+    get repertoireTags(): Record<string, import("./types").GroupRepertoireTag>;
+    get repertoireTagsList(): (import("./types").GroupRepertoireTag & {
+        id: string;
+    })[];
 }

package/{models → lib/models}/Group/index.js

@@ -7,6 +7,7 @@ const date_fns_1 = require("date-fns");
 const lodash_1 = require("lodash");
 const orders_1 = require("../../helpers/musicStyles/orders");
 const plans_1 = require("../../helpers/plans");
+const utils_1 = require("../../helpers/utils");
 const lang_1 = require("../../lang");
 const basic_1 = __importDefault(require("./basic"));
 const types_1 = require("./types");
@@ -90,7 +91,7 @@ class Group extends basic_1.default {
         return Object.keys(this.players);
     }
     get playersList() {
-        const players = this.activePlayers.map((playerId) => Object.assign({}, this.players[playerId], { id: playerId }));
+        const players = this.activePlayers.map((playerId) => (Object.assign(Object.assign({}, this.players[playerId]), { id: playerId })));
         return orders_1.orderByMusicStyle(players, 'mainInstrument', this.musicStyle);
     }
     get isActive() {
@@ -125,17 +126,17 @@ class Group extends basic_1.default {
     get config() {
         return this.data.config || {};
     }
-    get templates() {
-        return this.data.templates || {};
-    }
     get status() {
         return this.data.status;
     }
     get planId() {
         return this.data.planId;
     }
+    get templates() {
+        return this.data.templates || {};
+    }
     get templatesList() {
-        return Object.keys(this.templates).map((templateId) => Object.assign({}, this.templates[templateId], { id: templateId }));
+        return utils_1.objToArray(this.templates);
     }
     get satisfactionIndex() {
         return this.data.satisfactionIndex || { current: 0, last: 0 };
@@ -153,10 +154,16 @@ class Group extends basic_1.default {
         return this.data.stageTemplates || {};
     }
     get stageTemplatesList() {
-        return Object.keys(this.stageTemplates).map((templateId) => Object.assign({}, this.stageTemplates[templateId], { id: templateId }));
+        return utils_1.objToArray(this.stageTemplates);
     }
     get firstAnswerAt() {
         return this.data.firstAnswerAt || null;
     }
+    get repertoireTags() {
+        return this.data.repertoireTags || {};
+    }
+    get repertoireTagsList() {
+        return utils_1.objToArray(this.repertoireTags);
+    }
 }
 exports.default = Group;

package/{models → lib/models}/Group/types.d.ts

@@ -63,6 +63,13 @@ export interface GroupBasicData extends GroupTinyData {
     locality: string;
     location: GeoPoint;
 }
+export interface GroupRepertoireTag {
+    title: string;
+    default: boolean;
+}
+export interface AGroupRepertoireTag extends GroupRepertoireTag {
+    id: string;
+}
 export interface GroupData extends GroupBasicData {
     playerIds: string[];
     players: Record<string, PlayerBasicData>;
@@ -92,6 +99,7 @@ export interface GroupData extends GroupBasicData {
     stageTemplates: Record<string, StageTemplate>;
     metadata: Record<string, string>;
     firstAnswerAt: Timestamp | null;
+    repertoireTags: Record<string, GroupRepertoireTag>;
     readonly owner: DocumentReference;
     readonly createdAt: Timestamp;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@glissandoo/lib",
-	"version": "1.15.0",
+	"version": "1.15.1",
 	"description": "Glissandoo library js",
 	"main": "./index.js",
 	"types": "./index.d.ts",

package/models/User/Notification/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });