@shakerquiz/utilities 0.4.8 → 0.4.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shakerquiz/utilities",
-  "version": "0.4.8",
+  "version": "0.4.10",
   "author": "yurkimus <yurkimus@gmail.com>",
   "license": "ISC",
   "scripts": {

package/source/checkin.d.ts

@@ -0,0 +1,9 @@
+type CheckinResponse = {
+  email: UserTable['email']
+  first_name: UserTable['first_name']
+  id: UserTable['id']
+  last_name: UserTable['last_name']
+  phone: UserTable['phone']
+  third_name: UserTable['third_name']
+  role: RoleResponse
+}

package/source/city.d.ts

@@ -1,29 +1,4 @@
-type CityAdminResult = CityRow
-
-type CityOrganizerResult = CityRow
-
-type CityDefaultResult = {
-  address: CityRow['address']
-  alias: CityRow['alias']
-  country: CityRow['country']
-  custom_html: CityRow['custom_html']
-  custom_script: CityRow['custom_script']
-  email: CityRow['email']
-  id: CityRow['id']
-  inst_link: CityRow['inst_link']
-  max_members_count: CityRow['max_members_count']
-  meta_description: CityRow['meta_description']
-  meta_title: CityRow['meta_title']
-  min_members_count: CityRow['min_members_count']
-  name: CityRow['name']
-  phone: CityRow['phone']
-  tg_link: CityRow['tg_link']
-  vk_group_id: CityRow['vk_group_id']
-  vk_link: CityRow['vk_link']
-  yandex_metrica: CityRow['yandex_metrica']
-}
-
-type CityRow = {
+type CityTable = {
   /**
    * @description "timestamp with time zone"
    */
@@ -193,3 +168,24 @@ type CityRow = {
    */
   inst_link: string | null
 }
+
+type CityResponse = {
+  address: CityTable['address']
+  alias: CityTable['alias']
+  country: CityTable['country']
+  custom_html: CityTable['custom_html']
+  custom_script: CityTable['custom_script']
+  email: CityTable['email']
+  id: CityTable['id']
+  inst_link: CityTable['inst_link']
+  max_members_count: CityTable['max_members_count']
+  meta_description: CityTable['meta_description']
+  meta_title: CityTable['meta_title']
+  min_members_count: CityTable['min_members_count']
+  name: CityTable['name']
+  phone: CityTable['phone']
+  tg_link: CityTable['tg_link']
+  vk_group_id: CityTable['vk_group_id']
+  vk_link: CityTable['vk_link']
+  yandex_metrica: CityTable['yandex_metrica']
+}

package/source/enumerations/entities/roles.d.ts

@@ -1 +1 @@
-export const Roles: readonly ["admin", "organizer"];
+export const Roles: readonly ["admin", "default", "organizer"];

package/source/enumerations/entities/roles.js

@@ -1,4 +1,5 @@
 export var Roles = /** @type {const} */ ([
   'admin',
+  'default',
   'organizer',
 ])

package/source/game.d.ts

@@ -1,9 +1,9 @@
 type GameAdminResult = {
   // City
-  city_alias: CityRow['alias']
-  city_id: CityRow['id']
-  city_is_franchise: CityRow['is_franchise']
-  city_name: CityRow['name']
+  city_alias: CityTable['alias']
+  city_id: CityTable['id']
+  city_is_franchise: CityTable['is_franchise']
+  city_name: CityTable['name']
   // Event
   event_alias: GameRow['alias']
   event_id: GameRow['id']
@@ -11,26 +11,26 @@ type GameAdminResult = {
   event_status: GameRow['status']
   event_time: GameRow['event_time']
   // Location
-  location_id: VenueRow['id']
-  location_name: VenueRow['name']
+  location_id: VenueTable['id']
+  location_name: VenueTable['name']
   // Media
-  media_id: ImageMediaRow['id']
-  media_path: ImageMediaRow['path']
-  media_title: ImageMediaRow['title']
+  media_id: ImageMediaTable['id']
+  media_path: ImageMediaTable['path']
+  media_title: ImageMediaTable['title']
   // Custom
   people_amount: number
   people_reserve_amount: number
   teams_amount: number
   teams_reserve_amount: number
   // Theme
-  theme_id: ThemeRow['id']
-  theme_name: ThemeRow['name']
+  theme_id: ThemeTable['id']
+  theme_name: ThemeTable['name']
 }
 
 type GameDefaultResult = {
   // City
-  city_alias: CityRow['alias']
-  city_id: CityRow['id']
+  city_alias: CityTable['alias']
+  city_id: CityTable['id']
   // Event
   event_alias: GameRow['alias']
   event_currency: GameRow['currency']
@@ -42,29 +42,29 @@ type GameDefaultResult = {
   event_status: GameRow['status']
   event_time: GameRow['event_time']
   // Image
-  image_id: ImageMediaRow['id']
+  image_id: ImageMediaTable['id']
   // Location
-  location_house_number: VenueRow['house_number']
-  location_id: VenueRow['id']
-  location_info: VenueRow['location_info']
-  location_name: VenueRow['name']
-  location_street: VenueRow['street']
+  location_house_number: VenueTable['house_number']
+  location_id: VenueTable['id']
+  location_info: VenueTable['location_info']
+  location_name: VenueTable['name']
+  location_street: VenueTable['street']
   // Media
-  media_id: MediaRow['id']
-  media_path: MediaRow['path']
+  media_id: MediaTable['id']
+  media_path: MediaTable['path']
   // Theme
-  theme_description: ThemeRow['description']
-  theme_id: ThemeRow['id']
-  theme_name: ThemeRow['name']
-  theme_short_description: ThemeRow['short_description']
+  theme_description: ThemeTable['description']
+  theme_id: ThemeTable['id']
+  theme_name: ThemeTable['name']
+  theme_short_description: ThemeTable['short_description']
 }
 
 type GameOrginizerResult = {
   // City
-  city_alias: CityRow['alias']
-  city_id: CityRow['id']
-  city_is_franchise: CityRow['is_franchise']
-  city_name: CityRow['name']
+  city_alias: CityTable['alias']
+  city_id: CityTable['id']
+  city_is_franchise: CityTable['is_franchise']
+  city_name: CityTable['name']
   // Event
   event_alias: GameRow['alias']
   event_id: GameRow['id']
@@ -72,20 +72,20 @@ type GameOrginizerResult = {
   event_status: GameRow['status']
   event_time: GameRow['event_time']
   // Location
-  location_id: VenueRow['id']
-  location_name: VenueRow['name']
+  location_id: VenueTable['id']
+  location_name: VenueTable['name']
   // Media
-  media_id: ImageMediaRow['id']
-  media_path: ImageMediaRow['path']
-  media_title: ImageMediaRow['title']
+  media_id: ImageMediaTable['id']
+  media_path: ImageMediaTable['path']
+  media_title: ImageMediaTable['title']
   // Custom
   people_amount: number
   people_reserve_amount: number
   teams_amount: number
   teams_reserve_amount: number
   // Theme
-  theme_id: ThemeRow['id']
-  theme_name: ThemeRow['name']
+  theme_id: ThemeTable['id']
+  theme_name: ThemeTable['name']
 }
 
 type GameRow = {

package/source/image-media.d.ts

@@ -0,0 +1,30 @@
+type ImageMediaTable = {
+  /**
+   * @description "uuid"
+   */
+  media_id: string
+  /**
+   * @description "integer"
+   */
+  width: number | null
+  /**
+   * @description "integer"
+   */
+  height: number | null
+  /**
+   * @description "timestamp with time zone"
+   */
+  time_updated: string | null
+  /**
+   * @description "uuid"
+   */
+  id: string
+  /**
+   * @description "timestamp with time zone"
+   */
+  time_created: string
+  /**
+   * @description "character varying"
+   */
+  file_format: string | null
+}

package/source/index.d.ts

@@ -1,10 +1,12 @@
 /// <reference path='./globals.d.ts' />
 
+/// <reference path='./checkin.d.ts' />
 /// <reference path='./city.d.ts' />
 /// <reference path='./game.d.ts' />
+/// <reference path='./image-media.d.ts' />
+/// <reference path='./media.d.ts' />
 /// <reference path='./registration.d.ts' />
 /// <reference path='./role.d.ts' />
-/// <reference path='./rows.d.ts' />
 /// <reference path='./theme.d.ts' />
 /// <reference path='./user.d.ts' />
 /// <reference path='./venue.d.ts' />
@@ -28,7 +30,6 @@ export * from './enumerations/entities/roles.js'
 
 export * from './enumerations/schemas.js'
 
-export * from './functions/pathname.js'
 export * from './functions/schema.js'
 
 export * from './schemas/city.js'

package/source/index.js

@@ -4,7 +4,7 @@
 /// <reference path='./game.d.ts' />
 /// <reference path='./registration.d.ts' />
 /// <reference path='./role.d.ts' />
-/// <reference path='./rows.d.ts' />
+/// <reference path='./media.d.ts' />
 /// <reference path='./theme.d.ts' />
 /// <reference path='./user.d.ts' />
 /// <reference path='./venue.d.ts' />
@@ -28,7 +28,6 @@ export * from './enumerations/entities/roles.js'
 
 export * from './enumerations/schemas.js'
 
-export * from './functions/pathname.js'
 export * from './functions/schema.js'
 
 export * from './schemas/city.js'

package/source/media.d.ts

@@ -0,0 +1,30 @@
+type MediaTable = {
+  /**
+   * @description "uuid"
+   */
+  id: string
+  /**
+   * @description "timestamp with time zone"
+   */
+  time_created: string
+  /**
+   * @description "timestamp with time zone"
+   */
+  time_updated: string | null
+  /**
+   * @description "character varying"
+   */
+  title: string | null
+  /**
+   * @description "character varying"
+   */
+  cached_link: string | null
+  /**
+   * @description "character varying"
+   */
+  description: string | null
+  /**
+   * @description "character varying"
+   */
+  path: string | null
+}

package/source/registration.d.ts

@@ -1,26 +1,4 @@
-type RegistrationAdminResult = unknown
-
-type RegistrationDefaultResult = {
-  id: RegistrationRow['id']
-  event_id: RegistrationRow['event_id']
-  team_name: RegistrationRow['team_name']
-  is_canceled: RegistrationRow['is_canceled']
-  is_confirm: RegistrationRow['is_confirm']
-  is_reserve: RegistrationRow['is_reserve']
-  change_people_count: RegistrationRow['change_people_count']
-  people_count: RegistrationRow['people_count']
-  channel: RegistrationRow['channel']
-  event_time_utc: GameRow['event_time']
-  event_timezone: GameRow['timezone']
-  max_members_count: GameRow['max_members_count']
-  can_cancel: boolean
-  can_confirm: boolean
-  can_change_people_count: boolean
-}
-
-type RegistrationOrganizerResult = unknown
-
-type RegistrationRow = {
+type RegistrationTable = {
   /**
    * @description "boolean"
    */
@@ -150,3 +128,21 @@ type RegistrationRow = {
    */
   utm_content: string | null
 }
+
+type RegistrationResponse = {
+  can_cancel: boolean
+  can_change_people_count: boolean
+  can_confirm: boolean
+  change_people_count: RegistrationTable['change_people_count']
+  channel: RegistrationTable['channel']
+  event_id: RegistrationTable['event_id']
+  event_time_utc: GameRow['event_time']
+  event_timezone: GameRow['timezone']
+  id: RegistrationTable['id']
+  is_canceled: RegistrationTable['is_canceled']
+  is_confirm: RegistrationTable['is_confirm']
+  is_reserve: RegistrationTable['is_reserve']
+  max_members_count: GameRow['max_members_count']
+  people_count: RegistrationTable['people_count']
+  team_name: RegistrationTable['team_name']
+}

package/source/role.d.ts

@@ -1,4 +1,4 @@
-type RoleRow = {
+type RoleTable = {
   /**
    * @description "uuid"
    */
@@ -20,3 +20,11 @@ type RoleRow = {
    */
   description: string | null
 }
+
+type RoleResponse = {
+  id: RoleTable['id']
+  time_created: RoleTable['time_created']
+  time_updated: RoleTable['time_updated']
+  name: RoleTable['name']
+  description: RoleTable['description']
+}

package/source/theme.d.ts

@@ -1,28 +1,4 @@
-type ThemeAdminResult = {
-  id: ThemeRow['id']
-  time_created: ThemeRow['time_created']
-  name: ThemeRow['name']
-  description: ThemeRow['description']
-  short_description: ThemeRow['short_description']
-  image_id: ImageMediaRow['id']
-  media_title: MediaRow['title']
-  media_path: MediaRow['path']
-}
-
-type ThemeDefaultResult = unknown
-
-type ThemeOrganizerResult = {
-  id: ThemeRow['id']
-  time_created: ThemeRow['time_created']
-  name: ThemeRow['name']
-  description: ThemeRow['description']
-  short_description: ThemeRow['short_description']
-  image_id: ImageMediaRow['id']
-  media_title: MediaRow['title']
-  media_path: MediaRow['path']
-}
-
-type ThemeRow = {
+type ThemeTable = {
   /**
    * @description "timestamp with time zone"
    */
@@ -52,3 +28,14 @@ type ThemeRow = {
    */
   name: string | null
 }
+
+type ThemeResponse = {
+  description: ThemeTable['description']
+  id: ThemeTable['id']
+  image_id: ImageMediaTable['id']
+  media_path: MediaTable['path']
+  media_title: MediaTable['title']
+  name: ThemeTable['name']
+  short_description: ThemeTable['short_description']
+  time_created: ThemeTable['time_created']
+}

package/source/user.d.ts

@@ -1,55 +1,4 @@
-type CheckinAdminResult = {
-  id: UserRow['id']
-  first_name: UserRow['first_name']
-  last_name: UserRow['last_name']
-  third_name: UserRow['third_name']
-  phone: UserRow['phone']
-  email: UserRow['email']
-  image_id: ImageMediaRow['id']
-  role_id: RoleRow['id']
-  role_name: RoleRow['name']
-}
-
-type CheckinDefaultResult = {
-  id: '00000000-0000-0000-0000-000000000000'
-  role_id: '00000000-0000-0000-0000-000000000000'
-  role_name: 'default'
-}
-
-type CheckinOrganizerResult = {
-  id: UserRow['id']
-  first_name: UserRow['first_name']
-  last_name: UserRow['last_name']
-  third_name: UserRow['third_name']
-  phone: UserRow['phone']
-  email: UserRow['email']
-  image_id: ImageMediaRow['id']
-  role_id: RoleRow['id']
-  role_name: RoleRow['name']
-}
-
-type UserAdminResult = {
-  id: UserRow['id']
-  email: UserRow['email']
-  phone: UserRow['phone']
-  first_name: UserRow['first_name']
-  last_name: UserRow['last_name']
-  is_active: UserRow['is_active']
-  gmail_link: UserRow['gmail_link']
-  mailru_link: UserRow['mailru_link']
-  role_id: RoleRow['id']
-  role_name: RoleRow['name']
-  cities: {
-    id: CityRow['id']
-    name: CityRow['name']
-  }[]
-}
-
-type UserDefaultResult = unknown
-
-type UserOrganizerResult = unknown
-
-type UserRow = {
+type UserTable = {
   /**
    * @description "uuid"
    */
@@ -140,3 +89,16 @@ type UserRow = {
    */
   gmail_link: string | null
 }
+
+type UserResponse = {
+  email: UserTable['email']
+  first_name: UserTable['first_name']
+  gmail_link: UserTable['gmail_link']
+  id: UserTable['id']
+  is_active: UserTable['is_active']
+  last_name: UserTable['last_name']
+  mailru_link: UserTable['mailru_link']
+  phone: UserTable['phone']
+  role: RoleResponse
+  cities: CityResponse[]
+}

package/source/venue.d.ts

@@ -1,66 +1,4 @@
-type VenueAdminResult = {
-  // Venue
-  id: VenueRow['id']
-  time_created: VenueRow['time_created']
-  time_updated: VenueRow['time_updated']
-  longitude: VenueRow['longitude']
-  latitude: VenueRow['latitude']
-  people_capacity: VenueRow['people_capacity']
-  team_capacity: VenueRow['team_capacity']
-  is_adult: VenueRow['is_adult']
-  name: VenueRow['name']
-  house_number: VenueRow['house_number']
-  comment: VenueRow['comment']
-  comment_responsible: VenueRow['comment_responsible']
-  comment_equipment: VenueRow['comment_equipment']
-  street: VenueRow['street']
-  game_time: VenueRow['game_time']
-  floor: VenueRow['floor']
-  metro: VenueRow['metro']
-  location_info: VenueRow['location_info']
-  // City
-  city_id: CityRow['id']
-  city_name: CityRow['name']
-  city_timezone: CityRow['timezone']
-  city_price: CityRow['price']
-  city_currency: CityRow['currency']
-  city_min_members_count: CityRow['min_members_count']
-  city_max_members_count: CityRow['max_members_count']
-}
-
-type VenueDefaultResult = unknown
-
-type VenueOrganizerResult = {
-  // Venue
-  id: VenueRow['id']
-  time_created: VenueRow['time_created']
-  time_updated: VenueRow['time_updated']
-  longitude: VenueRow['longitude']
-  latitude: VenueRow['latitude']
-  people_capacity: VenueRow['people_capacity']
-  team_capacity: VenueRow['team_capacity']
-  is_adult: VenueRow['is_adult']
-  name: VenueRow['name']
-  house_number: VenueRow['house_number']
-  comment: VenueRow['comment']
-  comment_responsible: VenueRow['comment_responsible']
-  comment_equipment: VenueRow['comment_equipment']
-  street: VenueRow['street']
-  game_time: VenueRow['game_time']
-  floor: VenueRow['floor']
-  metro: VenueRow['metro']
-  location_info: VenueRow['location_info']
-  // City
-  city_id: CityRow['id']
-  city_name: CityRow['name']
-  city_timezone: CityRow['timezone']
-  city_price: CityRow['price']
-  city_currency: CityRow['currency']
-  city_min_members_count: CityRow['min_members_count']
-  city_max_members_count: CityRow['max_members_count']
-}
-
-type VenueRow = {
+type VenueTable = {
   /**
    * @description "uuid"
    */
@@ -138,3 +76,25 @@ type VenueRow = {
    */
   location_info: string | null
 }
+
+type VenueResponse = {
+  id: VenueTable['id']
+  time_created: VenueTable['time_created']
+  time_updated: VenueTable['time_updated']
+  longitude: VenueTable['longitude']
+  latitude: VenueTable['latitude']
+  people_capacity: VenueTable['people_capacity']
+  team_capacity: VenueTable['team_capacity']
+  is_adult: VenueTable['is_adult']
+  name: VenueTable['name']
+  house_number: VenueTable['house_number']
+  comment: VenueTable['comment']
+  comment_responsible: VenueTable['comment_responsible']
+  comment_equipment: VenueTable['comment_equipment']
+  street: VenueTable['street']
+  game_time: VenueTable['game_time']
+  floor: VenueTable['floor']
+  metro: VenueTable['metro']
+  location_info: VenueTable['location_info']
+  city: CityResponse
+}

package/source/functions/pathname.d.ts

@@ -1 +0,0 @@
-export function scopePathname(scope: Scope): string;

package/source/functions/pathname.js

@@ -1,35 +0,0 @@
-import { is } from '@yurkimus/types'
-
-import { FeatureKindPathname } from '../enumerations/core/features.js'
-import { Scopes } from '../enumerations/core/scopes.js'
-
-/**
- * @param {Scope} scope
- */
-export var scopePathname = scope => {
-  if (!Scopes.includes(scope))
-    throw TypeError(
-      `[scopePathname] Unknown scope '${scope}': not present in 'Scopes'.`,
-    )
-
-  var [method, feature, kind] = scope.split('/')
-
-  if (!(feature in FeatureKindPathname))
-    throw TypeError(
-      `[scopePathname] Feature '${feature}' is not defined in 'FeatureKindPathname'.`,
-    )
-
-  if (!(kind in FeatureKindPathname[feature]))
-    throw TypeError(
-      `[scopePathname] Kind '${kind}' is not defined under Feature '${feature}' in 'FeatureKindPathname'.`,
-    )
-
-  if (!is('String', FeatureKindPathname[feature][kind]))
-    throw TypeError(
-      `[scopePathname] Invalid value at FeatureKindPathname['${feature}']['${kind}']: expected a string, got '${typeof FeatureKindPathname[
-        feature
-      ][kind]}'.`,
-    )
-
-  return FeatureKindPathname[feature][kind]
-}

package/source/rows.d.ts

@@ -1,61 +0,0 @@
-type ImageMediaRow = {
-  /**
-   * @description "uuid"
-   */
-  media_id: string
-  /**
-   * @description "integer"
-   */
-  width: number | null
-  /**
-   * @description "integer"
-   */
-  height: number | null
-  /**
-   * @description "timestamp with time zone"
-   */
-  time_updated: string | null
-  /**
-   * @description "uuid"
-   */
-  id: string
-  /**
-   * @description "timestamp with time zone"
-   */
-  time_created: string
-  /**
-   * @description "character varying"
-   */
-  file_format: string | null
-}
-
-type MediaRow = {
-  /**
-   * @description "uuid"
-   */
-  id: string
-  /**
-   * @description "timestamp with time zone"
-   */
-  time_created: string
-  /**
-   * @description "timestamp with time zone"
-   */
-  time_updated: string | null
-  /**
-   * @description "character varying"
-   */
-  title: string | null
-  /**
-   * @description "character varying"
-   */
-  cached_link: string | null
-  /**
-   * @description "character varying"
-   */
-  description: string | null
-  /**
-   * @description "character varying"
-   */
-  path: string | null
-}