wedance-shared 1.0.0

package/.prettierrc.js

@@ -0,0 +1,8 @@
+export default {
+  semi: false,
+  trailingComma: 'none',
+  singleQuote: true,
+  printWidth: 80,
+  tabWidth: 2,
+  endOfLine: 'auto'
+} 

package/README.md

@@ -0,0 +1,18 @@
+# WeDance Shared Types
+
+This repository contains shared TypeScript types and interfaces used across multiple WeDance applications:
+
+- WeDance App (Mobile Application)
+- WeDance Web (Web Platform)
+- WeDance Cloud Functions
+
+## Purpose
+
+The purpose of this repository is to maintain a single source of truth for data types that are shared between different WeDance applications. This ensures consistency in data structures and reduces code duplication across the ecosystem.
+
+## Usage
+
+To use these shared types in your WeDance project:
+
+1. Add this repository as a dependency
+2. Import the required types

package/eslint.config.mjs

@@ -0,0 +1,36 @@
+import eslint from '@eslint/js'
+import tseslint from '@typescript-eslint/eslint-plugin'
+import typescript from '@typescript-eslint/parser'
+import prettier from 'eslint-config-prettier'
+import eslintPluginPrettier from 'eslint-plugin-prettier'
+
+export default [
+  eslint.configs.recommended,
+  {
+    files: ['src/**/*.ts'],
+    languageOptions: {
+      parser: typescript,
+      parserOptions: {
+        project: './tsconfig.json',
+        ecmaVersion: 2020,
+        sourceType: 'module'
+      }
+    },
+    plugins: {
+      '@typescript-eslint': tseslint,
+      prettier: eslintPluginPrettier
+    },
+    rules: {
+      'prettier/prettier': 'error',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-explicit-any': 'error',
+      '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+      'no-console': ['warn', { allow: ['warn', 'error'] }]
+    }
+  },
+  {
+    ignores: ['dist/**', 'node_modules/**', '*.js']
+  },
+  prettier
+] 

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "wedance-shared",
+  "version": "1.0.0",
+  "description": "This repository contains shared TypeScript types and interfaces used across multiple WeDance applications:",
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint \"src/**/*.ts\"",
+    "lint:fix": "eslint \"src/**/*.ts\" --fix",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "check-format": "prettier --check \"src/**/*.ts\"",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@eslint/js": "^9.19.0",
+    "@types/node": "^22.10.10",
+    "@typescript-eslint/eslint-plugin": "^8.21.0",
+    "@typescript-eslint/parser": "^8.21.0",
+    "eslint": "^9.19.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "prettier": "^3.4.2",
+    "typescript": "^5.7.3"
+  },
+  "type": "module"
+}

package/src/city.ts

@@ -0,0 +1,43 @@
+export const LIST_CITIES = [
+  {
+    city: 'helsinki',
+    country: 'fi',
+    coordinates: [60.1695, 24.9354] as const
+  },
+  {
+    city: 'tampere',
+    country: 'fi',
+    coordinates: [61.4978, 23.761] as const
+  },
+
+  {
+    city: 'oslo',
+    country: 'no',
+    coordinates: [59.9139, 10.7522] as const
+  },
+  // {
+  //   city: 'stockholm',
+  //   country: 'se',
+  // },
+  {
+    city: 'tallinn',
+    country: 'ee',
+    coordinates: [59.437, 24.7536] as const
+  },
+  {
+    city: 'copenhagen',
+    country: 'dk',
+    coordinates: [55.6761, 12.5683] as const
+  }
+] as const
+
+export type City = (typeof LIST_CITIES)[number]
+export type CityName = City['city']
+export type CountryCode = City['country']
+
+export enum Timezone {
+  FINLAND = 'Europe/Helsinki',
+  DENMARK = 'Europe/Copenhagen',
+  SWEDEN = 'Europe/Stockholm',
+  NORWAY = 'Europe/Oslo'
+}

package/src/event.ts

@@ -0,0 +1,98 @@
+import { City } from './city'
+import { OrganizerName } from './organizer'
+import { EventTicket } from './ticket'
+import { UserBadge } from './user'
+
+export type DanceTag = 'salsa' | 'kizomba' | 'bachata' | 'zouk'
+
+export type Organizer = {
+  name: OrganizerName
+  email?: string
+}
+
+export type Links = {
+  instagram?: string
+  facebook?: string
+  website?: string
+}
+
+type Location = {
+  name: string
+  address?: string
+}
+
+export type EventStatus = 'draft' | 'published' | 'cancelled'
+
+export type ImageData = {
+  url: string
+  alt?: string
+  blurhash?: string
+}
+
+/**
+ * This is the type of the data we get from the server
+ * */
+export type EventData = {
+  id: string
+  title: string
+  // Date in iso format
+  from: string
+  // Date in iso format
+  until: string
+  price: number
+  priceProvided: boolean
+  organizer: Organizer
+  description: string
+  location: Location
+  // In hours
+  duration?: number
+  tags: DanceTag[]
+  links: Links
+  /**
+   * Events have international artists
+   */
+  isInternational: boolean
+  /**
+   * Is event private? @deprecated
+   */
+  isPrivate?: boolean
+  hasSeveralPrices?: boolean
+  createdAt: string
+  lastUpdated?: string
+  publishedSchedule?: boolean
+  schedule: EventSchedule | null
+  // Email of the user who added the event
+  addedBy: string
+  updatedBy: string
+  paymentLink: string | null
+  status: EventStatus | null
+  city: City
+  isFestival: boolean | null
+  going: UserBadge[] | null
+  interested: UserBadge[] | null
+  imageData: ImageData
+  eventTickets?: EventTicket[] | null
+  lineup?: LineUpArtist[] | null
+}
+
+type EventCellType = 'workshop' | 'social' | 'break' | 'other'
+
+export type ScheduleItem = {
+  id: string
+  headline: string
+  subheader: string | null
+  from: string
+  until: string
+  type: EventCellType
+  level: string | null
+}
+
+export type EventSchedule = Record<string, ScheduleItem[]>
+
+export type LineUpArtist = {
+  id: string
+  name: string
+  description: string
+  image: string
+  imageUrl: string
+}

package/src/organizer.ts

@@ -0,0 +1,55 @@
+import { City } from './city'
+
+export type OrganizerName =
+  // HELSINKI
+  | 'SOB Productions'
+  | 'Helsinki SBK'
+  | 'Avec Dance Club'
+  | 'Still Dancing'
+  | 'Tanssikoulu SalsaLatina'
+  | 'Helsinki Salsa Academy'
+  | 'BabaGen'
+  | 'Bachata Studio'
+  | 'Tanssikoulu BailaBaila'
+  | 'Petra & Otso'
+  | 'Bachata Helsinki'
+  | 'Anton Kargaltsev'
+  | 'Salsa Borealis'
+  | 'Helsinki Dance Central'
+  | "Ted's Kizomba"
+  | 'Urbankiz Helsinki'
+  | 'Azembora'
+  | 'S-Dance'
+  | 'Helsinki Kizomba Studio'
+  | 'idance Helsinki'
+  // TAMPERE
+  | 'Tampere Social Dance'
+  | 'Azúcar'
+  | 'DJ Pies Locos'
+  | 'Kizomba Social Tampere'
+  // OSLO
+  | 'Fever Dance Oslo'
+  | 'Pure Dance Official'
+  | 'Dancecity'
+  | 'Bachata Monthly'
+  | 'Salsakompaniet'
+  // Tallinn
+  | 'Bachata Studio Tallinn'
+  | 'Casa De Baile'
+  | 'Havana Moderna'
+  // OTHER
+  | 'Other'
+
+export type OrganizerData = {
+  name: OrganizerName
+  email?: string
+  website?: string
+  city: City
+  description?: {
+    fi: string
+    en: string
+  }
+  lastUpdated: string
+  createdAt: string
+  isFlagged: boolean
+}

package/src/ticket.ts

@@ -0,0 +1,30 @@
+export type TicketStatus =
+  | 'Confirmed'
+  | 'Cancelled'
+  | 'Refunded'
+  | 'Expired'
+  | 'Used'
+  | 'Transferred'
+
+export type Ticket = {
+  id: string
+  eventId: string
+  eventName: string
+  eventDate: string
+  purchaseDate: string
+  quantity: number
+  ticketPrice: number
+  ticketType: string
+  previousOwner: string[]
+  owner: string
+  status: TicketStatus
+  isRefundable: boolean
+  isTransferable: boolean
+  paymentId: string
+}
+
+export type EventTicket = {
+  id: string
+  price: number
+  ticketType: string
+}

package/src/user.ts

@@ -0,0 +1,44 @@
+import { City } from './city'
+import { DanceTag } from './event'
+import { OrganizerName } from './organizer'
+import { Ticket } from './ticket'
+
+export type Role = 'admin' | 'manager' | 'organiser' | 'user'
+
+export type User = {
+  id: string
+  email: string
+  displayName: string
+  createdAt: string
+  lastUpdated?: string
+  lastConnected?: string
+  savedEvents: string[]
+  goingEvents: string[]
+  role: Role
+  managerCity?: City
+  organiser?: OrganizerName
+  city: City | null
+  followingOrganisers: OrganizerName[]
+  favoriteDance?: DanceTag
+  fcmTokens?: string[]
+  notificationPreferences?: NotificationPreferences
+  appVersion?: string
+  deviceModel?: string
+  platform?: string
+  tickets?: Ticket[]
+  emailVerified: boolean
+  stripeId?: string
+}
+
+export type NotificationPreferences = {
+  all: boolean
+}
+
+/**
+ * This is used to show who is going to the event
+ */
+export type UserBadge = {
+  id: string
+  displayName: string
+  avatar?: string
+}

package/tsconfig.json

@@ -0,0 +1,111 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "rewriteRelativeImportExtensions": true,          /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}