@kekkle/shared 0.0.10 → 1.0.0

package/README.md

@@ -10,21 +10,19 @@ npm install @kekkle-verse/shared
 
 ### Usage
 
-```typescript
-import { types, constants, enums } from "@kekkle-verse/shared";
-```
-
-or
+Import specific types, enums, or constants directly:
 
 ```typescript
-import * as shared from "@kekkle-verse/shared";
-```
+// Import types
+import type { User } from "@kekkle-verse/shared/types/user";
+import type { Group } from "@kekkle-verse/shared/types/group";
+import type { Comment } from "@kekkle-verse/shared/types/comment";
 
-or 
+// Import enums
+import { GroupPermission } from "@kekkle-verse/shared/enums/group-permission";
+import { PushSettingsOptions } from "@kekkle-verse/shared/enums/push-settings-options";
 
-```typescript
-import { user } from "@kekkle-verse/shared/types";
-import { permissions } from "@kekkle-verse/shared/enums";
-import { collections } from "@kekkle-verse/shared/constants";   
+// Import constants
+import { collections } from "@kekkle-verse/shared/constants/collections";
 ```
 

package/dist/cjs/helpers/permissions/is-valid-permission.d.ts

@@ -0,0 +1 @@
+export declare function isValidPermission(permission: string): boolean;

package/dist/cjs/helpers/permissions/is-valid-permission.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidPermission = isValidPermission;
+const group_permission_1 = require("../../enums/group-permission");
+function isValidPermission(permission) {
+    return Object.values(group_permission_1.GroupPermission).includes(permission);
+}

package/dist/esm/helpers/permissions/is-valid-permission.d.ts

@@ -0,0 +1 @@
+export declare function isValidPermission(permission: string): boolean;

package/dist/esm/helpers/permissions/is-valid-permission.js

@@ -0,0 +1,4 @@
+import { GroupPermission } from "../../enums/group-permission";
+export function isValidPermission(permission) {
+    return Object.values(GroupPermission).includes(permission);
+}

package/package.json

@@ -1,31 +1,32 @@
 {
   "name": "@kekkle/shared",
-  "version": "0.0.10",
+  "version": "1.0.0",
   "description": "Shared logic and types for Kekkle frontend and functions",
   "type": "module",
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js"
+    "./types/*": {
+      "types": "./src/types/*.ts",
+      "import": "./dist/esm/types/*.js",
+      "require": "./dist/cjs/types/*.js"
     },
-    "./types": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/esm/types/index.js",
-      "require": "./dist/cjs/types/index.js"
+    "./enums/*": {
+      "types": "./src/enums/*.ts",
+      "import": "./dist/esm/enums/*.js",
+      "require": "./dist/cjs/enums/*.js"
     },
-    "./enums": {
-      "types": "./dist/enums/index.d.ts",
-      "import": "./dist/esm/enums/index.js",
-      "require": "./dist/cjs/enums/index.js"
+    "./constants/*": {
+      "types": "./src/constants/*.ts",
+      "import": "./dist/esm/constants/*.js",
+      "require": "./dist/cjs/constants/*.js"
     },
-    "./constants": {
-      "types": "./dist/constants/index.d.ts",
-      "import": "./dist/esm/constants/index.js",
-      "require": "./dist/cjs/constants/index.js"
+    "./helpers/*": {
+      "types": "./src/helpers/*.ts",
+      "import": "./dist/esm/helpers/*.js",
+      "require": "./dist/cjs/helpers/*.js"
     }
   },
   "files": [
+    "src/**/*",
     "dist/**/*"
   ],
   "scripts": {
@@ -67,6 +68,7 @@
     "typescript-eslint": "^8.8.1"
   },
   "peerDependencies": {
-    "firebase-admin": "11.11.1"
+    "firebase-admin": "11.11.1",
+    "typescript": "^5.0.0"
   }
 }

package/src/constants/collections.ts

@@ -0,0 +1,6 @@
+export const USER_COLLECTION_PATH = "users";
+export const GROUP_COLLECTION_PATH = "groups";
+export const WORDLE_GAMES_COLLECTION_PATH = "wordle_games";
+export const WORDLE_LEADERBOARD_COLLECTION_PATH = "wordle_leaderboard";
+export const WORDLE_MONTHLY_SCORES_COLLECTION_PATH = "wordle_monthly_scores";
+export const WORDLE_SCORES_COLLECTION_PATH = "wordle_scores";

package/src/enums/group-permission.ts

@@ -0,0 +1,5 @@
+export enum GroupPermission {
+  ADMIN = "admin",
+  ORGANISER = "organiser",
+  MEMBER = "member",
+}

package/src/enums/push-settings-options.ts

@@ -0,0 +1,9 @@
+export enum PushSettingsOptions {
+  EVENT_CREATE = "event_create",
+  GROUP_MEMBER_JOINED = "group_member_joined",
+  QUOTE_CREATE = "quote_create",
+  QUOTE_COMMENT = "quote_comment",
+  EVENT_COMMENT = "event_comment",
+  PHOTO_CREATE = "photo_create",
+  PHOTO_COMMENT = "photo_comment",
+}

package/src/helpers/permissions/is-valid-permission.ts

@@ -0,0 +1,5 @@
+import { GroupPermission } from "../../enums/group-permission";
+
+export function isValidPermission(permission: string): boolean {
+  return Object.values(GroupPermission).includes(permission as GroupPermission);
+}

package/src/types/comment.ts

@@ -0,0 +1,11 @@
+import type { Timestamp } from "firebase-admin/firestore";
+
+type Comment = {
+  author: string;
+  comment: string;
+  date: Date | Timestamp;
+};
+
+export type PhotoComment = Comment;
+
+export type QuoteComment = Comment;

package/src/types/fcm-token.ts

@@ -0,0 +1 @@
+export type FcmToken = string;

package/src/types/group-general-data.ts

@@ -0,0 +1,6 @@
+export type GroupGeneralData = {
+  number_of_events: number;
+  number_of_members: number;
+  number_of_quotes: number;
+  number_of_photos: number;
+};

package/src/types/group-member.ts

@@ -0,0 +1,9 @@
+import { GroupPermission } from "../enums/group-permission";
+import type { Timestamp } from "firebase-admin/firestore";
+
+export type GroupMember = {
+  birthday: Timestamp | null;
+  name: string;
+  permission: GroupPermission;
+  profile_picture: string;
+};

package/src/types/group.ts

@@ -0,0 +1,21 @@
+import type { Timestamp } from "firebase-admin/firestore";
+import type { GroupGeneralData } from "./group-general-data";
+import type { GroupMember } from "./group-member";
+import type { Uid } from "./uid";
+
+export type Group = {
+  created_at: Timestamp;
+  updated_at: Timestamp;
+  description: string | undefined;
+  general_data: GroupGeneralData;
+  ical_token: string;
+  join_token: string | null | undefined;
+  join_token_timestamp: Timestamp | null | undefined;
+  members: {
+    [key: Uid]: GroupMember;
+  };
+  members_uuids: string[];
+  name: string;
+  premium: boolean | null | undefined;
+  premium_till: Timestamp | null | undefined;
+};

package/src/types/match-tries.ts

@@ -0,0 +1,9 @@
+export type MatchTries = {
+  "-1": number;
+  "1": number;
+  "2": number;
+  "3": number;
+  "4": number;
+  "5": number;
+  "6": number;
+};

package/src/types/push-document.ts

@@ -0,0 +1,26 @@
+import type { Timestamp } from "firebase-admin/firestore";
+
+import type { PushSettingsOptions } from "../enums/push-settings-options";
+import type { Uid } from "./uid";
+
+export type AllPushSettings = {
+  [key in PushSettingsOptions]: boolean | null;
+};
+
+export type GroupPushDocumentSettings = {
+  [key: Uid]: AllPushSettings;
+};
+
+export type GroupPushDocumentTokens = {
+  [key: Uid]: Array<PushTokenObject>;
+};
+
+export type PushTokenObject = {
+  token: string | null;
+  updated_at: Timestamp | string;
+};
+
+export type GroupPushDocument = {
+  settings: GroupPushDocumentSettings;
+  tokens: GroupPushDocumentTokens;
+};

package/src/types/quote.ts

@@ -0,0 +1,13 @@
+import type { Timestamp } from "firebase-admin/firestore";
+
+export type Quote = {
+  authors: Array<string> | null;
+  quote: string;
+  context: string | null;
+  created_by: string;
+  custom_author: string | null;
+  timestamp: Date | Timestamp;
+  trigrams: {
+    [key: string]: string;
+  } | null;
+};

package/src/types/uid.ts

@@ -0,0 +1 @@
+export type Uid = string;

package/src/types/user.ts

@@ -0,0 +1,14 @@
+import type { Timestamp } from "firebase-admin/firestore";
+import type { PushTokenObject, AllPushSettings } from "./push-document";
+
+export type User = {
+  active_group: "";
+  birthdate: Timestamp;
+  groups: string[];
+  message_tokens?: Array<PushTokenObject>;
+  push_settings?: AllPushSettings;
+  language?: string;
+  name: string;
+  new_auth_claim: boolean;
+  profile_picture: string;
+};

package/src/types/wordle-game-state.ts

@@ -0,0 +1,11 @@
+export type CharacterState = {
+  character: string;
+  isCorrect: boolean;
+  isLocked: boolean;
+};
+
+export type WordleRow = CharacterState[];
+
+export type WordleGameState = WordleRow[];
+
+export type StringifiedWordleGameState = string;

package/src/types/wordle-game.ts

@@ -0,0 +1,19 @@
+import type { Timestamp } from "firebase-admin/firestore";
+
+export type WordleGame = {
+  language: string;
+  word: string;
+  locked: boolean;
+  date: Timestamp;
+  created_at: Timestamp;
+  updated_at: Timestamp;
+  game_number: number;
+  year?: number;
+  month?: number;
+  date_number?: number;
+  day?: number;
+  year_utc?: number;
+  month_utc?: number;
+  date_number_utc?: number;
+  day_utc?: number;
+};

package/src/types/wordle-leaderboard.ts

@@ -0,0 +1,30 @@
+import type { Timestamp } from "firebase-admin/firestore";
+import type { MatchTries } from "./match-tries";
+
+export type WordleLeaderboard = {
+  created_at: Timestamp;
+  has_lost: number;
+  has_won: number;
+  language: string;
+  match_tries: MatchTries;
+  matches_played: string[];
+  new_score: number | null;
+  score: number;
+  updated_at: Timestamp;
+  username: string;
+  user_id: string;
+};
+
+export type PartialWordleLeaderboard = Partial<{
+  created_at: Timestamp;
+  has_lost: number;
+  has_won: number;
+  language: string;
+  match_tries: MatchTries;
+  matches_played: string[];
+  new_score: number | null;
+  score: number;
+  updated_at: Timestamp;
+  username: string;
+  user_id: string;
+}>;

package/src/types/wordle-monthly-score.ts

@@ -0,0 +1,34 @@
+import type { Timestamp } from "firebase-admin/firestore";
+import type { MatchTries } from "./match-tries";
+
+export type WordleMonthlyScore = {
+  created_at: Timestamp;
+  has_lost: number;
+  has_won: number;
+  language: string;
+  match_tries: MatchTries;
+  matches_played: string[];
+  month: number;
+  new_score: number;
+  score: number;
+  updated_at: Timestamp;
+  user_id: string;
+  username: string;
+  year: number;
+};
+
+export type PartialWordleMonthlyScore = Partial<{
+  created_at: Timestamp;
+  has_lost: number;
+  has_won: number;
+  language: string;
+  match_tries: MatchTries;
+  matches_played: string[];
+  month: number;
+  new_score: number;
+  score: number;
+  updated_at: Timestamp;
+  user_id: string;
+  username: string;
+  year: number;
+}>;

package/src/types/wordle-score.ts

@@ -0,0 +1,17 @@
+import type { Timestamp } from "firebase-admin/firestore";
+import type { StringifiedWordleGameState } from "./wordle-game-state";
+
+export type WordleScore = {
+  created_at: Timestamp;
+  game_id: string;
+  game_state: StringifiedWordleGameState;
+  has_lost: boolean;
+  has_won: boolean;
+  language: string;
+  new_score: number | null;
+  score: number;
+  number_of_tries_needed: number;
+  updated_at: Timestamp;
+  user_id: string;
+  username: string;
+};

package/src/types/worlde-game-state-document.ts

@@ -0,0 +1,13 @@
+import type { StringifiedWordleGameState } from "./wordle-game-state";
+import type { Timestamp } from "firebase-admin/firestore";
+
+export type WorldeGameStateDocument = {
+  calculated_score: number;
+  game_state: StringifiedWordleGameState;
+  has_finished: boolean;
+  has_lost: boolean;
+  has_won: boolean;
+  number_of_tries_needed: number;
+  updated_at: Timestamp;
+  user_id: string;
+};

package/dist/cjs/constants/index.d.ts

@@ -1 +0,0 @@
-export * from "./collections";

package/dist/cjs/constants/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./collections"), exports);

package/dist/cjs/enums/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./group-permission";
-export * from "./push-settings-options";

package/dist/cjs/enums/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./group-permission"), exports);
-__exportStar(require("./push-settings-options"), exports);

package/dist/cjs/index.d.ts

@@ -1,3 +0,0 @@
-export * as types from "./types";
-export * as enums from "./enums";
-export * as constants from "./constants";

package/dist/cjs/index.js

@@ -1,39 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.constants = exports.enums = exports.types = void 0;
-exports.types = __importStar(require("./types"));
-exports.enums = __importStar(require("./enums"));
-exports.constants = __importStar(require("./constants"));

package/dist/cjs/types/index.d.ts

@@ -1,16 +0,0 @@
-export * from "./comment";
-export * from "./fcm-token";
-export * from "./group-general-data";
-export * from "./group-member";
-export * from "./group";
-export * from "./match-tries";
-export * from "./push-document";
-export * from "./quote";
-export * from "./uid";
-export * from "./user";
-export * from "./wordle-game-state";
-export * from "./wordle-game";
-export * from "./wordle-leaderboard";
-export * from "./wordle-monthly-score";
-export * from "./wordle-monthly-score";
-export * from "./worlde-game-state-document";

package/dist/cjs/types/index.js

@@ -1,32 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./comment"), exports);
-__exportStar(require("./fcm-token"), exports);
-__exportStar(require("./group-general-data"), exports);
-__exportStar(require("./group-member"), exports);
-__exportStar(require("./group"), exports);
-__exportStar(require("./match-tries"), exports);
-__exportStar(require("./push-document"), exports);
-__exportStar(require("./quote"), exports);
-__exportStar(require("./uid"), exports);
-__exportStar(require("./user"), exports);
-__exportStar(require("./wordle-game-state"), exports);
-__exportStar(require("./wordle-game"), exports);
-__exportStar(require("./wordle-leaderboard"), exports);
-__exportStar(require("./wordle-monthly-score"), exports);
-__exportStar(require("./wordle-monthly-score"), exports);
-__exportStar(require("./worlde-game-state-document"), exports);

package/dist/esm/constants/index.d.ts

@@ -1 +0,0 @@
-export * from "./collections";

package/dist/esm/constants/index.js

@@ -1 +0,0 @@
-export * from "./collections";

package/dist/esm/enums/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./group-permission";
-export * from "./push-settings-options";

package/dist/esm/enums/index.js

@@ -1,2 +0,0 @@
-export * from "./group-permission";
-export * from "./push-settings-options";

package/dist/esm/index.d.ts

@@ -1,3 +0,0 @@
-export * as types from "./types";
-export * as enums from "./enums";
-export * as constants from "./constants";

package/dist/esm/index.js

@@ -1,3 +0,0 @@
-export * as types from "./types";
-export * as enums from "./enums";
-export * as constants from "./constants";

package/dist/esm/types/index.d.ts

@@ -1,16 +0,0 @@
-export * from "./comment";
-export * from "./fcm-token";
-export * from "./group-general-data";
-export * from "./group-member";
-export * from "./group";
-export * from "./match-tries";
-export * from "./push-document";
-export * from "./quote";
-export * from "./uid";
-export * from "./user";
-export * from "./wordle-game-state";
-export * from "./wordle-game";
-export * from "./wordle-leaderboard";
-export * from "./wordle-monthly-score";
-export * from "./wordle-monthly-score";
-export * from "./worlde-game-state-document";

package/dist/esm/types/index.js

@@ -1,16 +0,0 @@
-export * from "./comment";
-export * from "./fcm-token";
-export * from "./group-general-data";
-export * from "./group-member";
-export * from "./group";
-export * from "./match-tries";
-export * from "./push-document";
-export * from "./quote";
-export * from "./uid";
-export * from "./user";
-export * from "./wordle-game-state";
-export * from "./wordle-game";
-export * from "./wordle-leaderboard";
-export * from "./wordle-monthly-score";
-export * from "./wordle-monthly-score";
-export * from "./worlde-game-state-document";