@kekkle/shared 0.0.1

package/README.md

@@ -0,0 +1,30 @@
+## About this package
+
+This package contains shared logic, types, enums and constants for Kekkle frontend and functions.
+
+### Installation
+
+```bash
+npm install @kekkle-verse/shared
+```
+
+### Usage
+
+```typescript
+import { types, constants, enums } from "@kekkle-verse/shared";
+```
+
+or
+
+```typescript
+import * as shared from "@kekkle-verse/shared";
+```
+
+or 
+
+```typescript
+import { user } from "@kekkle-verse/shared/types";
+import { permissions } from "@kekkle-verse/shared/enums";
+import { collections } from "@kekkle-verse/shared/constants";   
+```
+

package/dist/constants/collections.d.ts

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

package/dist/constants/collections.js

@@ -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/dist/constants/index.d.ts

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

package/dist/constants/index.js

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

package/dist/enums/index.d.ts

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

package/dist/enums/index.js

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

package/dist/enums/permissions.d.ts

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

package/dist/enums/permissions.js

@@ -0,0 +1,6 @@
+export var GroupPermission;
+(function (GroupPermission) {
+    GroupPermission["ADMIN"] = "admin";
+    GroupPermission["ORGANISER"] = "organiser";
+    GroupPermission["MEMBER"] = "member";
+})(GroupPermission || (GroupPermission = {}));

package/dist/enums/push-settings-options.d.ts

@@ -0,0 +1,9 @@
+export declare 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/dist/enums/push-settings-options.js

@@ -0,0 +1,10 @@
+export var PushSettingsOptions;
+(function (PushSettingsOptions) {
+    PushSettingsOptions["EVENT_CREATE"] = "event_create";
+    PushSettingsOptions["GROUP_MEMBER_JOINED"] = "group_member_joined";
+    PushSettingsOptions["QUOTE_CREATE"] = "quote_create";
+    PushSettingsOptions["QUOTE_COMMENT"] = "quote_comment";
+    PushSettingsOptions["EVENT_COMMENT"] = "event_comment";
+    PushSettingsOptions["PHOTO_CREATE"] = "photo_create";
+    PushSettingsOptions["PHOTO_COMMENT"] = "photo_comment";
+})(PushSettingsOptions || (PushSettingsOptions = {}));

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/types/comment.d.ts

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

package/dist/types/comment.js

@@ -0,0 +1 @@
+export {};

package/dist/types/fcm-token.d.ts

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

package/dist/types/fcm-token.js

@@ -0,0 +1 @@
+export {};

package/dist/types/group-general-data.d.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/dist/types/group-general-data.js

@@ -0,0 +1 @@
+export {};

package/dist/types/group-member.d.ts

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

package/dist/types/group-member.js

@@ -0,0 +1 @@
+export {};

package/dist/types/group.d.ts

@@ -0,0 +1,20 @@
+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/dist/types/group.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+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/types/index.js

@@ -0,0 +1,16 @@
+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/types/match-tries.d.ts

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

package/dist/types/match-tries.js

@@ -0,0 +1 @@
+export {};

package/dist/types/push-document.d.ts

@@ -0,0 +1,20 @@
+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/dist/types/push-document.js

@@ -0,0 +1 @@
+export {};

package/dist/types/quote.d.ts

@@ -0,0 +1,12 @@
+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/dist/types/quote.js

@@ -0,0 +1 @@
+export {};

package/dist/types/uid.d.ts

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

package/dist/types/uid.js

@@ -0,0 +1 @@
+export {};

package/dist/types/user.d.ts

@@ -0,0 +1,13 @@
+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/dist/types/user.js

@@ -0,0 +1 @@
+export {};

package/dist/types/wordle-game-state.d.ts

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

package/dist/types/wordle-game-state.js

@@ -0,0 +1 @@
+export {};

package/dist/types/wordle-game.d.ts

@@ -0,0 +1,18 @@
+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/dist/types/wordle-game.js

@@ -0,0 +1 @@
+export {};

package/dist/types/wordle-leaderboard.d.ts

@@ -0,0 +1,28 @@
+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/dist/types/wordle-leaderboard.js

@@ -0,0 +1 @@
+export {};

package/dist/types/wordle-monthly-score.d.ts

@@ -0,0 +1,32 @@
+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/dist/types/wordle-monthly-score.js

@@ -0,0 +1 @@
+export {};

package/dist/types/worlde-game-state-document.d.ts

@@ -0,0 +1,12 @@
+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/types/worlde-game-state-document.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@kekkle/shared",
+  "version": "0.0.1",
+  "description": "Shared logic and types for Kekkle frontend and functions",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/types/index.js"
+    },
+    "./enums": {
+      "types": "./dist/enums/index.d.ts",
+      "import": "./dist/enums/index.js"
+    },
+    "./constants": {
+      "types": "./dist/constants/index.d.ts",
+      "import": "./dist/constants/index.js"
+    }
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kekkle-verse/shared.git"
+  },
+  "author": "Sam Freriks",
+  "bugs": {
+    "url": "https://github.com/kekkle-verse/shared/issues"
+  },
+  "homepage": "https://github.com/kekkle-verse/shared#readme",
+  "devDependencies": {
+    "@eslint/js": "^9.12.0",
+    "@types/eslint__js": "^8.42.3",
+    "eslint": "^9.12.0",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.8.1"
+  },
+  "peerDependencies": {
+    "firebase-admin": "11.11.1"
+  }
+}