Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: ✨ WellbeingPromptEntity and DailyPromptRecordEntity #23

Merged
merged 5 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions libs/prompt/domain/daily-prompt-record-entity/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# daily-prompt-record-entity

This library was generated with [Nx](https://nx.dev).

## Running unit tests

Run `nx test daily-prompt-record-entity` to execute the unit tests via [Jest](https://jestjs.io).
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
const baseConfig = require('../../../../eslint.config.js');

module.exports = [...baseConfig];
11 changes: 11 additions & 0 deletions libs/prompt/domain/daily-prompt-record-entity/jest.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
export default {
displayName: 'daily-prompt-record-entity',
preset: '../../../../jest.preset.js',
testEnvironment: 'node',
transform: {
'^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
},
moduleFileExtensions: ['ts', 'js', 'html'],
coverageDirectory:
'../../../../coverage/libs/prompt/domain/daily-prompt-record-entity',
};
9 changes: 9 additions & 0 deletions libs/prompt/domain/daily-prompt-record-entity/project.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "daily-prompt-record-entity",
"$schema": "../../../../node_modules/nx/schemas/project-schema.json",
"sourceRoot": "libs/prompt/domain/daily-prompt-record-entity/src",
"projectType": "library",
"tags": [],
"// targets": "to see all targets run: nx show project daily-prompt-record-entity --web",
"targets": {}
}
1 change: 1 addition & 0 deletions libs/prompt/domain/daily-prompt-record-entity/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './lib/daily-prompt-record-entity';
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import {type DailyPromptRecordEntity } from './daily-prompt-record-entity';

describe('DailyPromptRecordEntity', () => {
it('should have all required properties', () => {
const record: DailyPromptRecordEntity = {
id: '1',
promptId: 'prompt1',
userId: 'user1',
createdAt: new Date(),
completedAt: new Date(),
};

expect(record).toHaveProperty('id');
expect(record).toHaveProperty('promptId');
expect(record).toHaveProperty('userId');
expect(record).toHaveProperty('createdAt');
expect(record).toHaveProperty('completedAt');
});

it('should have correct types for properties', () => {
const record: DailyPromptRecordEntity = {
id: '1',
promptId: 'prompt1',
userId: 'user1',
createdAt: new Date(),
completedAt: new Date(),
};

expect(typeof record.id).toBe('string');
expect(typeof record.promptId).toBe('string');
expect(typeof record.userId).toBe('string');
expect(record.createdAt).toBeInstanceOf(Date);
expect(record.completedAt).toBeInstanceOf(Date);
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export interface DailyPromptRecordEntity {
id: string;
promptId: string;
userId: string;
createdAt: Date;
completedAt?: Date;
}
22 changes: 22 additions & 0 deletions libs/prompt/domain/daily-prompt-record-entity/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"extends": "../../../../tsconfig.base.json",
"compilerOptions": {
"module": "commonjs",
"forceConsistentCasingInFileNames": true,
"strict": true,
"noImplicitOverride": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"noPropertyAccessFromIndexSignature": true
},
"files": [],
"include": [],
"references": [
{
"path": "./tsconfig.lib.json"
},
{
"path": "./tsconfig.spec.json"
}
]
}
11 changes: 11 additions & 0 deletions libs/prompt/domain/daily-prompt-record-entity/tsconfig.lib.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"module": "commonjs",
"outDir": "../../../../dist/out-tsc",
"declaration": true,
"types": ["node"]
},
"exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
"include": ["src/**/*.ts"]
}
14 changes: 14 additions & 0 deletions libs/prompt/domain/daily-prompt-record-entity/tsconfig.spec.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"outDir": "../../../../dist/out-tsc",
"module": "commonjs",
"types": ["jest", "node"]
},
"include": [
"jest.config.ts",
"src/**/*.test.ts",
"src/**/*.spec.ts",
"src/**/*.d.ts"
]
}
7 changes: 7 additions & 0 deletions libs/prompt/domain/wellbeing-prompt-entity/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# wellbeing-prompt-entity

This library was generated with [Nx](https://nx.dev).

## Running unit tests

Run `nx test wellbeing-prompt-entity` to execute the unit tests via [Jest](https://jestjs.io).
3 changes: 3 additions & 0 deletions libs/prompt/domain/wellbeing-prompt-entity/eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
const baseConfig = require('../../../../eslint.config.js');

module.exports = [...baseConfig];
11 changes: 11 additions & 0 deletions libs/prompt/domain/wellbeing-prompt-entity/jest.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
export default {
displayName: 'wellbeing-prompt-entity',
preset: '../../../../jest.preset.js',
testEnvironment: 'node',
transform: {
'^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
},
moduleFileExtensions: ['ts', 'js', 'html'],
coverageDirectory:
'../../../../coverage/libs/prompt/domain/wellbeing-prompt-entity',
};
9 changes: 9 additions & 0 deletions libs/prompt/domain/wellbeing-prompt-entity/project.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "wellbeing-prompt-entity",
"$schema": "../../../../node_modules/nx/schemas/project-schema.json",
"sourceRoot": "libs/prompt/domain/wellbeing-prompt-entity/src",
"projectType": "library",
"tags": [],
"// targets": "to see all targets run: nx show project wellbeing-prompt-entity --web",
"targets": {}
}
1 change: 1 addition & 0 deletions libs/prompt/domain/wellbeing-prompt-entity/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './lib/wellbeing-prompt-entity';
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { WellbeingPromptEntity } from './wellbeing-prompt-entity';

describe('WellbeingPromptEntity', () => {
it('should create a valid WellbeingPromptEntity object', () => {
const wellbeingPrompt: WellbeingPromptEntity = {
id: '1',
content: 'Take a 5-minute walk outside.',
category: 'physical',
createdAt: new Date(),
};

expect(wellbeingPrompt).toBeDefined();
expect(wellbeingPrompt.id).toBe('1');
expect(wellbeingPrompt.content).toBe('Take a 5-minute walk outside.');
expect(wellbeingPrompt.category).toBe('physical');
expect(wellbeingPrompt.createdAt).toBeInstanceOf(Date);
});
zhumeisongsong marked this conversation as resolved.
Show resolved Hide resolved
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
type WellbeingCategory =
| 'physical'
| 'mental'
| 'social'
| 'emotional'
| 'mindfulness'
| 'productivity'
| 'self-care'
| 'gratitude'
| 'creativity';

export interface WellbeingPromptEntity {
id: string;
content: string;
category: WellbeingCategory;
createdAt: Date;
}
16 changes: 16 additions & 0 deletions libs/prompt/domain/wellbeing-prompt-entity/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"extends": "../../../../tsconfig.base.json",
"compilerOptions": {
"module": "commonjs"
},
"files": [],
"include": [],
"references": [
{
"path": "./tsconfig.lib.json"
},
{
"path": "./tsconfig.spec.json"
}
]
}
11 changes: 11 additions & 0 deletions libs/prompt/domain/wellbeing-prompt-entity/tsconfig.lib.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"module": "commonjs",
"outDir": "../../../../dist/out-tsc",
"declaration": true,
"types": ["node"]
},
"exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
"include": ["src/**/*.ts"]
}
14 changes: 14 additions & 0 deletions libs/prompt/domain/wellbeing-prompt-entity/tsconfig.spec.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"outDir": "../../../../dist/out-tsc",
"module": "commonjs",
"types": ["jest", "node"]
},
"include": [
"jest.config.ts",
"src/**/*.test.ts",
"src/**/*.spec.ts",
"src/**/*.d.ts"
]
}
6 changes: 6 additions & 0 deletions tsconfig.base.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
"paths": {
"@graphql-federation-workspace/applications-config": [
"libs/application-config/src/index.ts"
],
"@prompt/daily-prompt-record-entity": [
"libs/prompt/domain/daily-prompt-record-entity/src/index.ts"
],
"@prompt/wellbeing-prompt-entity": [
"libs/prompt/domain/wellbeing-prompt-entity/src/index.ts"
]
}
},
Expand Down