czapp-shared 1.0.37 → 1.0.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -118,6 +118,18 @@ interface IProgressHistoryDay {
118
118
  learningCount: number;
119
119
  retiredCount: number;
120
120
  }
121
+ /**
122
+ * One row of the reward points leaderboard. position is the user's 1-based rank across all users, ordered by
123
+ * rewardPoints, then highStreakLength, then sign-up order. name is the first name plus surname initial, never the
124
+ * full name.
125
+ */
126
+ interface ILeaderboardEntry {
127
+ position: number;
128
+ name: string;
129
+ rewardPoints: number;
130
+ highStreakLength: number;
131
+ isCurrentUser: boolean;
132
+ }
121
133
  type MySQLDate = `${number}-${number}-${number} ${number}:${number}:${number}`;
122
134
  type DateString = `${number}-${string}-${string}`;
123
135
  declare enum ReminderFrequency {
@@ -291,6 +303,7 @@ declare enum ApiPath {
291
303
  DATA_HEATMAP = "/data/heatmap/:weekCount/:endDate",
292
304
  HEALTH = "/health",
293
305
  LAST_WORDS_ADDED = "/lastWordsAdded",
306
+ LEADERBOARD = "/leaderboard",
294
307
  LEXEMES = "/lexemes",
295
308
  LEXEMES_ALL = "/lexemes/all",
296
309
  LEXEMES_COUNT = "/lexemes/count/:language",
@@ -476,4 +489,4 @@ type DeeplTranslation = {
476
489
  }>;
477
490
  };
478
491
 
479
- export { ApiMethod, ApiPath, AppError, type AutologinRequestBody, ClientPlatform, type ControllerResponse, type DateString, type DeeplTranslation, type DeleteLexemePairRequestParams, Familiarity, type HeatMapParams, type HeatMapResponseData, HttpStatusCode, type IActivityCount, type ICount, type ILexeme, type ILexemeIdPair, type ILexemeLearningInfo, type ILexemePair, type ILexemePairTexts, type IProgressHistoryDay, type ISession, type ITestResult, type IUserData, type IVocabCheckActivity, type InsertOrUpdateRequestBody, type InsertOrUpdateResponseData, LEARNING_STAGES_IN_GROUP, Language, LearningStage, LearningStageGroup, Lexeme, LexemePair, type LexemePairRequestBody, type LexemePairWithLang, type MySQLDate, Progress, type RecycleLexemePairParams, type RegisterPushTokenRequestBody, ReminderFrequency, type ResetTestUserParams, type Result, Scenario, type SelectAllTranslationsParams, type SelectLexemeCountParams, type SelectLexemePairParams, type SelectLexemePairsByTextParams, type SelectLexemesParams, type SelectProgressHistoryParams, type SelectTestLexemesParams, type SelectVocabCheckActivityParams, type SignInRequestBody, type SignInResponseData, type Streaks, type TestCompleteRequestBody, type TestCompleteResponseData, type TestInitRequestBody, type TestInitResponseData, type TranslationRequestBody, type TranslationResponseData, type UpdateLexemePairFamiliarityParams, type UpdateOnboardingStatusRequestBody, type UpdateUserRequestBody, VocabCheckType, convertJSDateStringToMySQLDate, dateDifferenceInDays, deriveStreakFromVocabCheckActivity, getFormattedDate, getMysqlDateIgnoreTZ, isClientDateTooFarFromServerDate, isExpired, isFinalTest, isLearningStageGroup, isStringContainingInteger, isThePreviousDay, isTheSameDay, isValidJsDateString, isValidMysqlDateString, parameterReplace };
492
+ export { ApiMethod, ApiPath, AppError, type AutologinRequestBody, ClientPlatform, type ControllerResponse, type DateString, type DeeplTranslation, type DeleteLexemePairRequestParams, Familiarity, type HeatMapParams, type HeatMapResponseData, HttpStatusCode, type IActivityCount, type ICount, type ILeaderboardEntry, type ILexeme, type ILexemeIdPair, type ILexemeLearningInfo, type ILexemePair, type ILexemePairTexts, type IProgressHistoryDay, type ISession, type ITestResult, type IUserData, type IVocabCheckActivity, type InsertOrUpdateRequestBody, type InsertOrUpdateResponseData, LEARNING_STAGES_IN_GROUP, Language, LearningStage, LearningStageGroup, Lexeme, LexemePair, type LexemePairRequestBody, type LexemePairWithLang, type MySQLDate, Progress, type RecycleLexemePairParams, type RegisterPushTokenRequestBody, ReminderFrequency, type ResetTestUserParams, type Result, Scenario, type SelectAllTranslationsParams, type SelectLexemeCountParams, type SelectLexemePairParams, type SelectLexemePairsByTextParams, type SelectLexemesParams, type SelectProgressHistoryParams, type SelectTestLexemesParams, type SelectVocabCheckActivityParams, type SignInRequestBody, type SignInResponseData, type Streaks, type TestCompleteRequestBody, type TestCompleteResponseData, type TestInitRequestBody, type TestInitResponseData, type TranslationRequestBody, type TranslationResponseData, type UpdateLexemePairFamiliarityParams, type UpdateOnboardingStatusRequestBody, type UpdateUserRequestBody, VocabCheckType, convertJSDateStringToMySQLDate, dateDifferenceInDays, deriveStreakFromVocabCheckActivity, getFormattedDate, getMysqlDateIgnoreTZ, isClientDateTooFarFromServerDate, isExpired, isFinalTest, isLearningStageGroup, isStringContainingInteger, isThePreviousDay, isTheSameDay, isValidJsDateString, isValidMysqlDateString, parameterReplace };
package/dist/index.d.ts CHANGED
@@ -118,6 +118,18 @@ interface IProgressHistoryDay {
118
118
  learningCount: number;
119
119
  retiredCount: number;
120
120
  }
121
+ /**
122
+ * One row of the reward points leaderboard. position is the user's 1-based rank across all users, ordered by
123
+ * rewardPoints, then highStreakLength, then sign-up order. name is the first name plus surname initial, never the
124
+ * full name.
125
+ */
126
+ interface ILeaderboardEntry {
127
+ position: number;
128
+ name: string;
129
+ rewardPoints: number;
130
+ highStreakLength: number;
131
+ isCurrentUser: boolean;
132
+ }
121
133
  type MySQLDate = `${number}-${number}-${number} ${number}:${number}:${number}`;
122
134
  type DateString = `${number}-${string}-${string}`;
123
135
  declare enum ReminderFrequency {
@@ -291,6 +303,7 @@ declare enum ApiPath {
291
303
  DATA_HEATMAP = "/data/heatmap/:weekCount/:endDate",
292
304
  HEALTH = "/health",
293
305
  LAST_WORDS_ADDED = "/lastWordsAdded",
306
+ LEADERBOARD = "/leaderboard",
294
307
  LEXEMES = "/lexemes",
295
308
  LEXEMES_ALL = "/lexemes/all",
296
309
  LEXEMES_COUNT = "/lexemes/count/:language",
@@ -476,4 +489,4 @@ type DeeplTranslation = {
476
489
  }>;
477
490
  };
478
491
 
479
- export { ApiMethod, ApiPath, AppError, type AutologinRequestBody, ClientPlatform, type ControllerResponse, type DateString, type DeeplTranslation, type DeleteLexemePairRequestParams, Familiarity, type HeatMapParams, type HeatMapResponseData, HttpStatusCode, type IActivityCount, type ICount, type ILexeme, type ILexemeIdPair, type ILexemeLearningInfo, type ILexemePair, type ILexemePairTexts, type IProgressHistoryDay, type ISession, type ITestResult, type IUserData, type IVocabCheckActivity, type InsertOrUpdateRequestBody, type InsertOrUpdateResponseData, LEARNING_STAGES_IN_GROUP, Language, LearningStage, LearningStageGroup, Lexeme, LexemePair, type LexemePairRequestBody, type LexemePairWithLang, type MySQLDate, Progress, type RecycleLexemePairParams, type RegisterPushTokenRequestBody, ReminderFrequency, type ResetTestUserParams, type Result, Scenario, type SelectAllTranslationsParams, type SelectLexemeCountParams, type SelectLexemePairParams, type SelectLexemePairsByTextParams, type SelectLexemesParams, type SelectProgressHistoryParams, type SelectTestLexemesParams, type SelectVocabCheckActivityParams, type SignInRequestBody, type SignInResponseData, type Streaks, type TestCompleteRequestBody, type TestCompleteResponseData, type TestInitRequestBody, type TestInitResponseData, type TranslationRequestBody, type TranslationResponseData, type UpdateLexemePairFamiliarityParams, type UpdateOnboardingStatusRequestBody, type UpdateUserRequestBody, VocabCheckType, convertJSDateStringToMySQLDate, dateDifferenceInDays, deriveStreakFromVocabCheckActivity, getFormattedDate, getMysqlDateIgnoreTZ, isClientDateTooFarFromServerDate, isExpired, isFinalTest, isLearningStageGroup, isStringContainingInteger, isThePreviousDay, isTheSameDay, isValidJsDateString, isValidMysqlDateString, parameterReplace };
492
+ export { ApiMethod, ApiPath, AppError, type AutologinRequestBody, ClientPlatform, type ControllerResponse, type DateString, type DeeplTranslation, type DeleteLexemePairRequestParams, Familiarity, type HeatMapParams, type HeatMapResponseData, HttpStatusCode, type IActivityCount, type ICount, type ILeaderboardEntry, type ILexeme, type ILexemeIdPair, type ILexemeLearningInfo, type ILexemePair, type ILexemePairTexts, type IProgressHistoryDay, type ISession, type ITestResult, type IUserData, type IVocabCheckActivity, type InsertOrUpdateRequestBody, type InsertOrUpdateResponseData, LEARNING_STAGES_IN_GROUP, Language, LearningStage, LearningStageGroup, Lexeme, LexemePair, type LexemePairRequestBody, type LexemePairWithLang, type MySQLDate, Progress, type RecycleLexemePairParams, type RegisterPushTokenRequestBody, ReminderFrequency, type ResetTestUserParams, type Result, Scenario, type SelectAllTranslationsParams, type SelectLexemeCountParams, type SelectLexemePairParams, type SelectLexemePairsByTextParams, type SelectLexemesParams, type SelectProgressHistoryParams, type SelectTestLexemesParams, type SelectVocabCheckActivityParams, type SignInRequestBody, type SignInResponseData, type Streaks, type TestCompleteRequestBody, type TestCompleteResponseData, type TestInitRequestBody, type TestInitResponseData, type TranslationRequestBody, type TranslationResponseData, type UpdateLexemePairFamiliarityParams, type UpdateOnboardingStatusRequestBody, type UpdateUserRequestBody, VocabCheckType, convertJSDateStringToMySQLDate, dateDifferenceInDays, deriveStreakFromVocabCheckActivity, getFormattedDate, getMysqlDateIgnoreTZ, isClientDateTooFarFromServerDate, isExpired, isFinalTest, isLearningStageGroup, isStringContainingInteger, isThePreviousDay, isTheSameDay, isValidJsDateString, isValidMysqlDateString, parameterReplace };
package/dist/index.js CHANGED
@@ -311,6 +311,7 @@ var ApiPath = /* @__PURE__ */ ((ApiPath2) => {
311
311
  ApiPath2["DATA_HEATMAP"] = "/data/heatmap/:weekCount/:endDate";
312
312
  ApiPath2["HEALTH"] = "/health";
313
313
  ApiPath2["LAST_WORDS_ADDED"] = "/lastWordsAdded";
314
+ ApiPath2["LEADERBOARD"] = "/leaderboard";
314
315
  ApiPath2["LEXEMES"] = "/lexemes";
315
316
  ApiPath2["LEXEMES_ALL"] = "/lexemes/all";
316
317
  ApiPath2["LEXEMES_COUNT"] = "/lexemes/count/:language";
package/dist/index.mjs CHANGED
@@ -256,6 +256,7 @@ var ApiPath = /* @__PURE__ */ ((ApiPath2) => {
256
256
  ApiPath2["DATA_HEATMAP"] = "/data/heatmap/:weekCount/:endDate";
257
257
  ApiPath2["HEALTH"] = "/health";
258
258
  ApiPath2["LAST_WORDS_ADDED"] = "/lastWordsAdded";
259
+ ApiPath2["LEADERBOARD"] = "/leaderboard";
259
260
  ApiPath2["LEXEMES"] = "/lexemes";
260
261
  ApiPath2["LEXEMES_ALL"] = "/lexemes/all";
261
262
  ApiPath2["LEXEMES_COUNT"] = "/lexemes/count/:language";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "czapp-shared",
3
- "version": "1.0.37",
3
+ "version": "1.0.38",
4
4
  "description": "This is a shared library for Czapp projects. It contains common code that is used across multiple projects.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
package/src/design/api.ts CHANGED
@@ -35,6 +35,7 @@ export enum ApiPath {
35
35
  DATA_HEATMAP = '/data/heatmap/:weekCount/:endDate',
36
36
  HEALTH = '/health',
37
37
  LAST_WORDS_ADDED = '/lastWordsAdded',
38
+ LEADERBOARD = '/leaderboard',
38
39
  LEXEMES = '/lexemes',
39
40
  LEXEMES_ALL = '/lexemes/all',
40
41
  LEXEMES_COUNT = '/lexemes/count/:language',
@@ -84,6 +84,19 @@ export interface IProgressHistoryDay {
84
84
  retiredCount: number;
85
85
  }
86
86
 
87
+ /**
88
+ * One row of the reward points leaderboard. position is the user's 1-based rank across all users, ordered by
89
+ * rewardPoints, then highStreakLength, then sign-up order. name is the first name plus surname initial, never the
90
+ * full name.
91
+ */
92
+ export interface ILeaderboardEntry {
93
+ position: number;
94
+ name: string;
95
+ rewardPoints: number;
96
+ highStreakLength: number;
97
+ isCurrentUser: boolean;
98
+ }
99
+
87
100
  export type MySQLDate = `${number}-${number}-${number} ${number}:${number}:${number}`;
88
101
 
89
102
  export type DateString = `${number}-${string}-${string}`;