czapp-shared 1.0.35 → 1.0.36

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
@@ -108,6 +108,16 @@ interface IVocabCheckActivity {
108
108
  flashcardCount: number;
109
109
  testQuestionCount: number;
110
110
  }
111
+ /**
112
+ * A user's lexeme pair counts per LearningStageGroup as recorded on a given day. learningCount
113
+ * includes NEW pairs, matching the LearningStageGroup.LEARNING grouping.
114
+ */
115
+ interface IProgressHistoryDay {
116
+ date: DateString;
117
+ queuedCount: number;
118
+ learningCount: number;
119
+ retiredCount: number;
120
+ }
111
121
  type MySQLDate = `${number}-${number}-${number} ${number}:${number}:${number}`;
112
122
  type DateString = `${number}-${string}-${string}`;
113
123
  declare enum ReminderFrequency {
@@ -292,6 +302,7 @@ declare enum ApiPath {
292
302
  LEXEME_PAIR_FAMILIARITY = "/lexemePair/:czId/:enId/:familiarity",
293
303
  LEXEME_PAIR_COUNT = "/lexemePairCount",
294
304
  LEXEME_PAIR_RECYCLE = "/lexemePair/recycle/:czId/:enId",
305
+ PROGRESS_HISTORY = "/progressHistory/:endDate/:noOfDays",
295
306
  PUSH_TOKEN = "/user/pushToken",
296
307
  SIGN_IN = "/signIn",
297
308
  SIGN_OUT = "/signOut",
@@ -407,6 +418,10 @@ interface SelectVocabCheckActivityParams {
407
418
  endDate: DateString;
408
419
  noOfDays: number;
409
420
  }
421
+ interface SelectProgressHistoryParams {
422
+ endDate: DateString;
423
+ noOfDays: number;
424
+ }
410
425
  /**
411
426
  * Response payloads
412
427
  */
@@ -455,4 +470,4 @@ type DeeplTranslation = {
455
470
  }>;
456
471
  };
457
472
 
458
- 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 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 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 };
473
+ 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 };
package/dist/index.d.ts CHANGED
@@ -108,6 +108,16 @@ interface IVocabCheckActivity {
108
108
  flashcardCount: number;
109
109
  testQuestionCount: number;
110
110
  }
111
+ /**
112
+ * A user's lexeme pair counts per LearningStageGroup as recorded on a given day. learningCount
113
+ * includes NEW pairs, matching the LearningStageGroup.LEARNING grouping.
114
+ */
115
+ interface IProgressHistoryDay {
116
+ date: DateString;
117
+ queuedCount: number;
118
+ learningCount: number;
119
+ retiredCount: number;
120
+ }
111
121
  type MySQLDate = `${number}-${number}-${number} ${number}:${number}:${number}`;
112
122
  type DateString = `${number}-${string}-${string}`;
113
123
  declare enum ReminderFrequency {
@@ -292,6 +302,7 @@ declare enum ApiPath {
292
302
  LEXEME_PAIR_FAMILIARITY = "/lexemePair/:czId/:enId/:familiarity",
293
303
  LEXEME_PAIR_COUNT = "/lexemePairCount",
294
304
  LEXEME_PAIR_RECYCLE = "/lexemePair/recycle/:czId/:enId",
305
+ PROGRESS_HISTORY = "/progressHistory/:endDate/:noOfDays",
295
306
  PUSH_TOKEN = "/user/pushToken",
296
307
  SIGN_IN = "/signIn",
297
308
  SIGN_OUT = "/signOut",
@@ -407,6 +418,10 @@ interface SelectVocabCheckActivityParams {
407
418
  endDate: DateString;
408
419
  noOfDays: number;
409
420
  }
421
+ interface SelectProgressHistoryParams {
422
+ endDate: DateString;
423
+ noOfDays: number;
424
+ }
410
425
  /**
411
426
  * Response payloads
412
427
  */
@@ -455,4 +470,4 @@ type DeeplTranslation = {
455
470
  }>;
456
471
  };
457
472
 
458
- 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 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 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 };
473
+ 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 };
package/dist/index.js CHANGED
@@ -322,6 +322,7 @@ var ApiPath = /* @__PURE__ */ ((ApiPath2) => {
322
322
  ApiPath2["LEXEME_PAIR_FAMILIARITY"] = "/lexemePair/:czId/:enId/:familiarity";
323
323
  ApiPath2["LEXEME_PAIR_COUNT"] = "/lexemePairCount";
324
324
  ApiPath2["LEXEME_PAIR_RECYCLE"] = "/lexemePair/recycle/:czId/:enId";
325
+ ApiPath2["PROGRESS_HISTORY"] = "/progressHistory/:endDate/:noOfDays";
325
326
  ApiPath2["PUSH_TOKEN"] = "/user/pushToken";
326
327
  ApiPath2["SIGN_IN"] = "/signIn";
327
328
  ApiPath2["SIGN_OUT"] = "/signOut";
package/dist/index.mjs CHANGED
@@ -267,6 +267,7 @@ var ApiPath = /* @__PURE__ */ ((ApiPath2) => {
267
267
  ApiPath2["LEXEME_PAIR_FAMILIARITY"] = "/lexemePair/:czId/:enId/:familiarity";
268
268
  ApiPath2["LEXEME_PAIR_COUNT"] = "/lexemePairCount";
269
269
  ApiPath2["LEXEME_PAIR_RECYCLE"] = "/lexemePair/recycle/:czId/:enId";
270
+ ApiPath2["PROGRESS_HISTORY"] = "/progressHistory/:endDate/:noOfDays";
270
271
  ApiPath2["PUSH_TOKEN"] = "/user/pushToken";
271
272
  ApiPath2["SIGN_IN"] = "/signIn";
272
273
  ApiPath2["SIGN_OUT"] = "/signOut";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "czapp-shared",
3
- "version": "1.0.35",
3
+ "version": "1.0.36",
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
@@ -47,6 +47,7 @@ export enum ApiPath {
47
47
  LEXEME_PAIR_FAMILIARITY = '/lexemePair/:czId/:enId/:familiarity',
48
48
  LEXEME_PAIR_COUNT = '/lexemePairCount',
49
49
  LEXEME_PAIR_RECYCLE = '/lexemePair/recycle/:czId/:enId',
50
+ PROGRESS_HISTORY = '/progressHistory/:endDate/:noOfDays',
50
51
  PUSH_TOKEN = '/user/pushToken',
51
52
  SIGN_IN = '/signIn',
52
53
  SIGN_OUT = '/signOut',
@@ -167,6 +168,10 @@ export interface SelectVocabCheckActivityParams {
167
168
  endDate: DateString;
168
169
  noOfDays: number;
169
170
  }
171
+ export interface SelectProgressHistoryParams {
172
+ endDate: DateString;
173
+ noOfDays: number;
174
+ }
170
175
 
171
176
 
172
177
  /**
@@ -73,6 +73,17 @@ export interface IVocabCheckActivity {
73
73
  testQuestionCount: number
74
74
  }
75
75
 
76
+ /**
77
+ * A user's lexeme pair counts per LearningStageGroup as recorded on a given day. learningCount
78
+ * includes NEW pairs, matching the LearningStageGroup.LEARNING grouping.
79
+ */
80
+ export interface IProgressHistoryDay {
81
+ date: DateString;
82
+ queuedCount: number;
83
+ learningCount: number;
84
+ retiredCount: number;
85
+ }
86
+
76
87
  export type MySQLDate = `${number}-${number}-${number} ${number}:${number}:${number}`;
77
88
 
78
89
  export type DateString = `${number}-${string}-${string}`;