@clidey/dory 0.1.0 → 0.3.0

package/docs/configuration/app-settings/feature-flags.mdx

@@ -1,157 +0,0 @@
----
-title: 'Feature Flags'
-description: 'Manage and understand feature flags affecting the application behavior.'
----
-
-# Feature Flags
-
-## Purpose and Scope
-
-The Feature Flags module provides a centralized mechanism to enable or disable specific features within the Genie application dynamically. This approach allows controlled rollout, testing, and gradual adoption of new functionalities without deploying new code versions.
-
-This module primarily parses and validates feature flag configurations from environment variables and exposes them for use throughout the web and API services.
-
-## Technical Overview
-
-Feature Flags are defined and validated using the `zod` schema validation library to ensure that flag values comply with expected types. Flags can generally be boolean or strings convertible to booleans (`"true"`), permitting flexibility in how environment variables are specified.
-
-The parsing logic safely attempts to read environment variables, falling back to an empty object on failure and capturing exceptions with Sentry for monitoring.
-
-### Key Locations
-
-- **Web client feature flags:** Defined and parsed in `apps/web/src/utils/feature-flags.ts`.
-- **API service feature flags:** Defined under API config schemas in `apps/api/src/config/schemas/index.ts`.
-
-
-## Core Concepts and Responsibilities
-
-- **Feature Flags Schema:** A set of typed mappings that describe each flag's expected type and optional presence.
-- Flags can be a boolean or a string (`"true"` interpreted as `true`) or undefined.
-- Certain flags have additional typed definitions such as arrays, e.g., `DEMAND_PLANNER_SHOP_ALLOW_LIST` which is an optional array of strings.
-
-- **Error Handling:** Parsing errors are logged to Sentry via `Sentry.captureException(error)` to facilitate early detection of misconfiguration.
-
-- **Environmental Scope:** Flags are read from environment variables prefixed with `NEXT_PUBLIC_FEATURE_FLAGS` for frontend exposure or `FEATURE_FLAGS` for the backend.
-
-- **Security and Scope:** Flags must be explicitly defined in environment configuration, preventing undefined or unexpected flags from being used.
-
-## Code Structure
-
-### `apps/web/src/utils/feature-flags.ts`
-
-This file implements the feature flag parsing logic for the web frontend.
-
-- `flagSchema`: Accepts either a boolean or a string representing booleans and transforms the string to a boolean.
-- `featureFlagsSchema`: Defines known feature flags such as `UI_PAGE`, `DEMAND_PLANNER`, `MOV`, `PAYMENT_TERMS`, and others. Some flags are booleans, others arrays of strings.
-- `parseFeatureFlags()`:
-  - Attempts to JSON parse the environment variable `NEXT_PUBLIC_FEATURE_FLAGS`.
-  - Validates it against the schema.
-  - On error, logs to Sentry and returns an empty object.
-- `FEATURE_FLAGS`: Exported constant representing the parsed flags for app-wide consumption.
-
-```ts
-import { z } from "zod";
-import * as Sentry from "@sentry/nextjs";
-
-const flagSchema = z.union([
-  z.boolean(),
-  z.string().transform((val) => val === "true")
-]).optional();
-
-const featureFlagsSchema = z.object({
-  UI_PAGE: flagSchema,
-  DEMAND_PLANNER: flagSchema,
-  DEMAND_PLANNER_SHOP_ALLOW_LIST: z.array(z.string()).optional(),
-  MOV: flagSchema,
-  PAYMENT_TERMS: flagSchema,
-  MANUAL_STATUS: flagSchema,
-  REPORTS_ALERTS: flagSchema,
-  PAYMENTS_PAGE: flagSchema,
-});
-
-type FeatureFlags = z.infer<typeof featureFlagsSchema>;
-
-const parseFeatureFlags = (): FeatureFlags => {
-  try {
-    return featureFlagsSchema.parse(
-      JSON.parse(process.env.NEXT_PUBLIC_FEATURE_FLAGS || "{}")
-    );
-  } catch (error) {
-    Sentry.captureException(error);
-    return {};
-  }
-};
-
-export const FEATURE_FLAGS = parseFeatureFlags();
-```
-
-### `apps/api/src/config/schemas/index.ts`
-
-This file extends feature flag support within the API backend.
-
-- The API uses a similar schema (`featureFlagSchema`) that accepts booleans or strings convertible to booleans.
-- `featureFlagsSchema` is defined but currently empty (`z.object({} satisfies Record<string, typeof featureFlagSchema>)`).
-- The `FEATURE_FLAGS` environment variable is parsed and coerced to a string, then JSON parsed and validated.
-
-The config schema merges the feature flags, along with many other env vars, into a consolidated validation schema.
-
-```ts
-const featureFlagSchema = z.union([
-  z.boolean(),
-  z.string().transform((value) => value === "true")
-]).optional();
-
-const featureFlagsSchema = z.object(
-  {} satisfies Record<string, typeof featureFlagSchema>
-);
-
-export type FeatureFlags = z.infer<typeof featureFlagsSchema>;
-
-export const configSchema = z.object({
-  // ... other config fields ...
-  FEATURE_FLAGS: z.coerce.string().optional().transform((jsonString = "{}") =>
-    featureFlagsSchema.parse(JSON.parse(jsonString))
-  ),
-  // ... other config fields ...
-}).merge(databaseConfigSchema).strip();
-```
-
-## Environment & Configuration
-
-### Environment Variables
-
-- `NEXT_PUBLIC_FEATURE_FLAGS` (frontend): JSON string representing flags.
-- `FEATURE_FLAGS` (API backend): JSON string representing flags.
-
-Example environment value for frontend (simplified):
-
-```json
-{
-  "UI_PAGE": true,
-  "DEMAND_PLANNER": "true",
-  "DEMAND_PLANNER_SHOP_ALLOW_LIST": ["shop1", "shop2"],
-  "MOV": false
-}
-```
-
-The environment variable must be valid JSON and correctly typed for each feature flag.
-
-## Integration & System Boundaries
-
-- **Web UI:** Uses parsed `FEATURE_FLAGS` to enable/disable UI features.
-- **API:** Reads feature flags from environment on startup to alter backend behavior.
-- **Error Logging:** Parsing issues send errors to Sentry for diagnosis.
-
-## Observability & Error Handling
-
-- Parsing errors of feature flags are monitored via Sentry.
-- Apps fall back gracefully to default empty flags on error, ensuring stability.
-
-## Summary
-
-This feature flags module provides a robust, type-safe approach to managing application features dynamically through environment configuration. It ensures flags are validated on startup and exposes them as constants for consistent use across frontend and backend components.
-
-## References
-
-- [Feature Flags in Web Frontend](apps/web/src/utils/feature-flags.ts)
-- [Feature Flags in API Config](apps/api/src/config/schemas/index.ts)

package/docs/configuration/app-settings/user-settings.mdx

@@ -1,201 +0,0 @@
----
-title: 'User and Team Settings'
-description: 'Configuration of user preferences, team settings, saved views, and insights settings.'
----
-
-## User and Team Settings - Internal Developer Documentation
-
-### 1. Purpose and Scope
-
-This module handles **user and team settings management** within the Genie application, enabling users to configure team-wide preferences, manage memberships, and control notifications. It provides REST API endpoints to update and retrieve team general settings, insights settings, shop settings, and manage invitations and team members.
-
-The module's responsibilities include:
-- CRUD operations on team settings (general, insights, shop).
-- Managing team member invitations and acceptance.
-- Deactivating users from a team.
-- Querying team membership and invitation status.
-- Managing user notification preferences.
-
-It acts as a boundary between frontend clients and backend services managing persistent storage and business logic related to teams and user contexts.
-
-### 2. Technical Overview
-
-The main components involved are:
-
-- **TeamsController** (`apps/api/src/user-management/controllers/teams.controller.ts`): API entrypoint defining HTTP routes for team settings and team user management.
-- **SettingsService** (`apps/api/src/user-management/services/settings.service.ts`): Business logic for retrieving and updating team settings.
-- **TeamsService** (`apps/api/src/user-management/services/teams.service.ts`): Business logic for user and invitation management within teams.
-- **UserContextController** (`apps/api/src/user-management/controllers/user-context.controller.ts`): Manages retrieval of user context and notification preferences.
-
-The module leverages **NestJS** for structuring controllers and services and **TypeORM** for database interactions with `TeamEntity`, `UserEntity`, and `MemberInvitationEntity`.
-
-Dependencies include:
-- Shared DTOs and schemas from `@genie/shared` for payload validation.
-- Zod validation pipes for input validation.
-- JWT service for token handling during invitation acceptance.
-
-#### Architectural Pattern:
-- The system follows an **MVC-style architecture** where Controllers handle HTTP requests, delegate to Services for business logic, and Services interact with entities via repositories.
-
-### 3. Core Concepts and Responsibilities
-
-- **Team Settings** are divided into:
-  - **General Settings**: Business name, contact info, VAT, and address.
-  - **Insights Settings**: Sales period days, stock levels, and grading strategy parameters.
-  - **Shop Settings**: Currency and timezone.
-
-- **Users and Invitations**:
-  - Invitations are managed as entities with statuses (Pending, Accepted, Expired).
-  - An invitation can be sent, accepted with validation and token generation, or expired.
-  - Only Admin users can deactivate users.
-
-- **Notification Settings**:
-  - Stored as JSON config inside team entity under `notifications`.
-  - Users can retrieve and update their notification preferences.
-
-- **Error Handling**:
-  - If requests come from users with no team association, `GenieException` with "User not in a team" message is thrown.
-  - Role-based authorization on critical operations like user deactivation.
-
-- **Security**:
-  - Invitation acceptance requires a valid code (invitation ID) and checks for expiration.
-  - JWT tokens are issued upon invitation acceptance.
-
-### 4. Code Structure
-
-| File | Description |
-|-------|-------------|
-| `teams.controller.ts` | API endpoints for team settings and user management (send invitations, deactivate users, retrieve members) |
-| `settings.service.ts` | Implements logic to get and update team settings in the DB, including insights and shop settings |
-| `teams.service.ts` | Handles user retrieval, invitations, notification states, team user management, and tokenized invitation acceptance |
-| `user-context.controller.ts` | API endpoints to get user context and manage user notification preferences |
-| `team.entity.ts` | Defines Team entity schema, including settings fields and onboarding states |
-| `user.entity.ts` | Defines User entity schema and relations to team |
-
-
-#### Example snippet from TeamsController showing settings update endpoint:
-```ts
-@Put("settings")
-@HttpCode(204)
-async updateTeamSettings(@Request() { user }: RequestWithUser, @Body(new ZodValidationPipe(teamSettingsDtoSchema)) settings: TeamSettingsDto) {
-  if (!user.teamId) throw new GenieException("User not in a team");
-  await this.settingsService.updateTeamSettings(user.teamId, settings);
-}
-```
-
-### 5. API and Interfaces
-
-#### TeamsController Endpoints Summary
-
-| Endpoint                      | Method | Description                                         | Req. Auth | Input (DTO)                          | Output                   |
-|-------------------------------|--------|-----------------------------------------------------|-----------|-------------------------------------|--------------------------|
-| `/teams/settings`              | PUT    | Update complete team settings                      | Yes       | `TeamSettingsDto`                    | 204 No Content           |
-| `/teams/settings/general`      | PUT    | Update team general settings                        | Yes       | `TeamGeneralSettingsDto`             | 204 No Content           |
-| `/teams/settings/general`      | GET    | Get team general settings                           | Yes       | -                                   | `TeamGeneralSettingsDto` |
-| `/teams/settings/insights`     | PUT    | Update team insights settings                       | Yes       | `InsightsSettingsDto`                 | 204 No Content           |
-| `/teams/settings/insights`     | GET    | Get team insights settings                          | Yes       | -                                   | `InsightsSettingsDto`      |
-| `/teams/settings/shop`         | GET    | Get team shop settings (currency, timezone)        | Yes       | -                                   | `GetShopSettingsResponseDto` |
-| `/teams/members`               | GET    | Get all team members and invitations               | Yes       | -                                   | `GetTeamUsersInfoResponseDto` |
-| `/teams/send-invitations`      | POST   | Send invitations to new members                     | Yes       | `SendInvitationsRequestDto`          | `SendInvitationsResponseDto` |
-| `/teams/user/:id/deactivate`  | PATCH  | Deactivate a user (admin-only)                      | Yes       | -                                   | 204 No Content           |
-| `/teams/invitations/:email`    | DELETE | Remove an invitation by email                       | Yes       | -                                   | 204 No Content           |
-| `/teams/accept-invitation`     | POST   | Accept invitation and obtain auth token            | No        | `AcceptInvitationRequestDto`         | `{ token: string }`       |
-
-#### UserContextController Endpoints
-
-| Endpoint                | Method | Description                    | Auth   | Input                   | Output                         |
-|-------------------------|--------|--------------------------------|--------|-------------------------|-------------------------------|
-| `/user-context`          | GET    | Get current user context       | Yes    | -                       | `GetUserContextResponseDto`   |
-| `/user-context/notifications` | GET    | Get user/team notification prefs | Yes    | -                       | `UserNotificationsSchema`      |
-| `/user-context/notifications` | PUT    | Update notification preferences | Yes    | `UserNotificationsSchema` | 204 No Content                 |
-
-#### API Validation
-- All request bodies are validated using `ZodValidationPipe` based on shared DTO schemas.
-- User authorization checks confirm user belongs to a team before proceeding.
-
-#### Failure Modes
-- Throws `GenieException` with clear messages for unauthorized or invalid operations, e.g. "User not in a team", "Only team admins can remove users".
-- Invitation acceptance fails with `ForbiddenException` for invalid or expired codes.
-
-### 6. Environment & Configuration
-
-- Uses environment variables for:
-  - Intercom secret (`INTERCOM_IDENTITY_VERIFICATION_SECRET`) for generating user hashes.
-  - Team integration tokens for Mantle subscription management.
-
-- Slack app token and channel IDs are used indirectly via injected `SlackService` for notifications when related to teams.
-
-- Team settings updates impact DB table `team` via TypeORM repository.
-
-- JWT secret utilized by `JwtService` for signing tokens on invitation acceptance.
-
-### 7. Testing, Monitoring, and Deployment
-
-- Standard NestJS testing practices apply. Unit and integration tests should cover:
-  - Controller endpoint authorization and validation.
-  - Service method's DB interactions and error handling.
-
-- Observability:
-  - Errors throw `GenieException` which integrates with centralized error handling.
-  - Logging and tracing occur in related services (not detailed here).
-
-- Deployment follows standard service lifecycle as per NestJS backend.
-
-### 8. Troubleshooting & Known Issues
-
-- Common failure if the user is not assigned to a team is consistently checked in controllers.
-- Admin-only restrictions on deactivation ensure minimal privilege violations.
-- Expired or invalid invitation codes are handled explicitly with meaningful exceptions.
-
-### 9. Style and Tone Guidelines
-
-- Terminology consistent with codebase entities: "team", "user", "invitation", "settings".
-- Methods first check authorization and preconditions, then perform updates.
-- API uses HTTP 204 status for successful PUT/PATCH requests with no response body.
-
----
-
-## Mermaid Diagram: Teams and User Settings Module Architecture
-
-```mermaid
-flowchart TD
-  subgraph API Layer
-    TeamsController["TeamsController<br/>(HTTP API)" ]:::api
-    UserContextController["UserContextController<br/>(User Context API)"]:::api
-  end
-
-  subgraph Services Layer
-    SettingsService["SettingsService<br/>Team Settings Logic"]:::service
-    TeamsService["TeamsService<br/>User & Invitations Logic"]:::service
-  end
-
-  subgraph Persistence Layer
-    TeamEntity["TeamEntity<br/>(Postgres DB)"]:::db
-    UserEntity["UserEntity<br/>(Postgres DB)"]:::db
-    MemberInvitationEntity["MemberInvitationEntity<br/>(Postgres DB)"]:::db
-  end
-
-  %% Relationships
-  TeamsController -->|calls| SettingsService
-  TeamsController -->|calls| TeamsService
-  UserContextController -->|calls| TeamsService
-
-  SettingsService -->|reads/writes| TeamEntity
-  TeamsService -->|reads/writes| UserEntity
-  TeamsService -->|reads/writes| TeamEntity
-  TeamsService -->|reads/writes| MemberInvitationEntity
-
-  %% Classes styles
-  classDef api fill:#f9f,stroke:#333,stroke-width:1px,color:#000
-  classDef service fill:#bbf,stroke:#333,stroke-width:1px,color:#000
-  classDef db fill:#bfb,stroke:#060,stroke-width:1px,color:#060
-
-  %% Click events
-  click TeamsController "apps/api/src/user-management/controllers/teams.controller.ts"
-  click UserContextController "apps/api/src/user-management/controllers/user-context.controller.ts"
-  click SettingsService "apps/api/src/user-management/services/settings.service.ts"
-  click TeamsService "apps/api/src/user-management/services/teams.service.ts"
-  click TeamEntity "apps/api/src/user-management/entities/team.entity.ts"
-  click UserEntity "apps/api/src/user-management/entities/user.entity.ts"
-  click MemberInvitationEntity "apps/api/src/user-management/entities/member-invitation.entity.ts"
-```

package/docs/configuration/installation-setup/env-vars.mdx

@@ -1,198 +0,0 @@
----
-title: 'Environment Variables & Configuration'
-description: 'Details of required environment variables, example values, and configuration across dev, staging, and prod.'
----
-
-# Environment Variables & Configuration
-
-## Purpose and Scope
-
-This document provides a detailed technical overview of the environment variables and configuration management within the Genie application, specifically focusing on how team, shop, and general settings are handled. It covers the backend service responsible for settings management, the structure of configuration data, integration points with external services (notably Shopify), and the interaction with frontend components for settings updates.
-
-The scope is limited to the environment and configuration aspects related to team settings, insights, shop configurations, and business details within the Genie platform. It clarifies the flow and storage of configuration data, including environment-dependent settings like time zone and currency.
-
-## Technical Overview
-
-The SettingsService in the backend manages the core configuration and environment-specific settings at the team level. It acts as the interface to stored data for team general settings, insights settings, and shop settings, primarily through the `TeamEntity` persisted in the database.
-
-### System Boundaries and Architecture
-
-- **Backend:** The `SettingsService` uses TypeORM repository to read and update the `TeamEntity` database representation.
-- **Frontend:** React-based web UI components fetch and mutate settings by invoking API endpoints which under the hood use `SettingsService`.
-- **External API Integration:** Shopify data such as shop currency and time zone are imported into the team settings and validated.
-
-### Key Technologies and Patterns
-
-- **NestJS** with the `@Injectable()` pattern for service injection.
-- **TypeORM** to interface with PostgreSQL or relational DB for `TeamEntity` storage.
-- **Data Transfer Objects (DTOs)** encapsulate settings data structures for transmission between layers.
-- **React Query** in the frontend for data fetching and mutation.
-
-### Configuration Data Flow
-
-1. Shopify data (currency, time zone) imported via webhooks or manual sync.
-2. Stored persistently in the `TeamEntity` fields (`currency`, `timeZone`).
-3. General team business settings stored as JSON in `generalSettings` in the same entity.
-4. Insights settings regarding inventory grading, sales periods, etc., stored via dedicated columns.
-5. Frontend reads/writes through APIs that delegate to `SettingsService` methods.
-
-```mermaid
-flowchart TD
-  subgraph Backend
-    SS["SettingsService"]:::service
-    TE["TeamEntity (DB Model)"]:::database
-  end
-
-  subgraph Frontend
-    GU["GeneralSettings UI Component"]:::frontend
-  end
-
-  subgraph Shopify
-    SH["Shopify API / Webhook"]:::external
-  end
-
-  GU -->|"API calls for get/update settings"| SS
-  SS -->|"Read/Write settings"| TE
-  SH -->|"Push shop data (currency/timezone)"| SS
-
-  classDef service fill:#1976d2,color:#fff,stroke:#0b3d91,stroke-width:1px;
-  classDef database fill:#795548,color:#fff,stroke:#5d4037,stroke-width:1px;
-  classDef frontend fill:#388e3c,color:#fff,stroke:#2e7d32,stroke-width:1px;
-  classDef external fill:#fbc02d,color:#000,stroke:#f9a825,stroke-width:1px;
-
-  click SS "apps/api/src/user-management/services/settings.service.ts"
-  click TE "apps/api/src/user-management/entities/team.entity.ts"
-  click GU "apps/web/src/components/pages/settings/general-settings.tsx"
-```
-
-## Core Concepts and Responsibilities
-
-### Team Settings
-
-- Represented primarily by `TeamEntity`.
-- Contains both simple scalar settings (e.g., `name`, `currency`, `timeZone`) and complex JSON blobs (e.g., `generalSettings`, `stockLevelsSettings`).
-- Manages onboarding, enabled state, and disables reasons.
-
-### Insights Settings
-
-- Includes inventory grading strategy and threshold levels.
-- Important validation: `InventoryItemGradingStrategy.SalesFrequency` is explicitly unsupported and raises exceptions.
-
-### Shopify Integration
-
-- The Shopify shop data (e.g., currency, time zone) is imported and validated. Time zone validation is done via `isValidTimeZone`.
-- Defaults to `Etc/UTC` if invalid or missing.
-
-### Error Handling
-
-- Uses `GenieException` to encapsulate errors with context, such as team ID or invalid states.
-
-### Ownership
-
-- Maintained by the user management backend module.
-- Settings changes propagate via API and frontend UI.
-
-### Non-functional Requirements
-
-- Time zone and currency are critical for correct operation and must always be valid.
-- The system must guard against unsupported grading strategies.
-- Updates must be atomic and error-resilient.
-
-## Code Structure
-
-| File/Folder                      | Role Description                                       |
-|---------------------------------|--------------------------------------------------------|
-| `apps/api/src/user-management/services/settings.service.ts` | Core backend logic for loading and updating team settings. |
-| `apps/api/src/user-management/entities/team.entity.ts`      | Database entity modeling the team configuration persistently. |
-| `apps/web/src/components/pages/settings/general-settings.tsx` | Frontend UI component for managing general team and shop settings. |
-| `apps/web/src/api/resources/settings`                         | API layer exports for settings-related calls. |
-
-### Key Code Snippet from `SettingsService`
-
-```ts
-async updateTeamGeneralSettings(teamId: string, settings: TeamGeneralSettingsDto) {
-  const { businessName: name, ...generalSettings } = settings;
-  try {
-    await this.teamRepository.update(teamId, {
-      name,
-      generalSettings,
-    });
-  } catch (error) {
-    throw new GenieException("Failed to update team general settings", {
-      error,
-      teamId,
-      settings,
-    });
-  }
-}
-```
-
-This method extracts the business name to the `name` column and stores other general settings in the JSON field `generalSettings`.
-
-## API and Interfaces
-
-### Key Methods in `SettingsService`
-
-| Method                        | Description                                         | Input                          | Output                           |
-|-------------------------------|----------------------------------------------------|---------------------------------|----------------------------------|
-| `getTeamGeneralSettings`      | Retrieves general team settings.                    | `teamId: string`                | `TeamGeneralSettingsDto`          |
-| `updateTeamGeneralSettings`   | Updates general team settings.                      | `teamId: string`, `TeamGeneralSettingsDto` | void                             |
-| `getTeamInsightsSettings`     | Retrieves team insights settings.                   | `teamId: string`                | `InsightsSettingsDto`             |
-| `updateTeamInsightsSettings`  | Updates insights settings including grading configs.| `teamId: string`, `InsightsSettingsDto` | void                             |
-| `getShopSettings`             | Retrieves the shop-level config like currency, timezone.| `teamId: string`              | `GetShopSettingsResponseDto`      |
-| `saveShopSettings`            | Saves Shopify shop currency and time zone settings.| `teamId: string`, Optional Shopify webhook payload | void                     |
-
-### Error Conditions
-
-- Unsupported inventory grading strategies throw a `GenieException`.
-- Any update failure results in a thrown exception with contextual info including the failing settings and team ID.
-
-### Frontend Integration
-
-- Uses React Query hooks such as `useGetTeamGeneralSettingsQuery` and mutation hooks `useUpdateTeamGeneralSettingsMutation`.
-- UI includes controlled forms managing business details and Shopify sync status.
-
-## Environment & Configuration
-
-### Team Configuration Properties
-
-| Setting                              | Type                     | Description                                               | Default / Validation                  |
-|------------------------------------|--------------------------|-----------------------------------------------------------|--------------------------------------|
-| `name`                             | string                   | Business name of the team.                                 | Nullable, stored in `name` column.   |
-| `generalSettings`                  | JSON object              | Business address, VAT number, contact info, etc.          | Stored in JSON column.                |
-| `currency`                        | string                   | Team's accounting/display currency.                       | From Shopify, nullable.               |
-| `timeZone`                       | string                   | IANA time zone identifier for the team/shop.             | Default: `Etc/UTC`, validated against timezone list. |
-| `averageDailySalesPeriodDaysSetting` | integer Enum (7,30,60,90,180) | Period for sales averaging in analysis.                   | Default: 30                          |
-| `inventoryItemGradingPeriodDaysSetting` | integer Enum             | Period over which inventory grading is calculated.       | Default: 30                          |
-| `inventoryItemGradingStrategySetting` | Enum `InventoryItemGradingStrategy` | The strategy for inventory grading (e.g., SalesRevenue). | Default: `SalesRevenue`, `SalesFrequency` disallowed. |
-| `inventoryItemGradingLevelAThresholdSetting` | integer              | Threshold % for grading level A.                           | Default: 80                          |
-| `inventoryItemGradingLevelBThresholdSetting` | integer              | Threshold % for grading level B.                           | Default: 15                          |
-| `inventoryItemGradingLevelCThresholdSetting` | integer              | Threshold % for grading level C.                           | Default: 5                           |
-| `stockLevelsSettings`             | JSON object              | Settings for stock buffer, lead time, reorder frequency. | Defaults to leadTime=30, stockBuffer=10, reorderFrequency=EveryTwoMonths |
-
-### Shopify Environment Integration
-
-- Shopify shop data such as currency and IANA time zone are pulled from webhook payloads or API calls.
-- Time zone validation is performed by `isValidTimeZone` utility.
-- If invalid or missing, time zone falls back to `Etc/UTC`.
-
-### Local Development and Environment Setup
-
-- Environment variables managing database and Shopify credentials are outside the scope of this document.
-- Configuration for environment management likely handled in `ConfigModule` and `ConfigService` (referenced exports), but specific environment variables are not detailed here.
-
-## Testing, Monitoring, and Deployment
-
-- Test details for settings service and UI are unspecified.
-- Error conditions raise `GenieException` logged with context for debugging.
-- Frontend mutation success triggers user notifications.
-
-## Troubleshooting & Known Issues
-
-- Attempting to use the unsupported `SalesFrequency` grading strategy results in explicit exceptions.
-- Manual Shopify sync on the frontend has race-condition warnings (HTTP 409) if multiple syncs are attempted simultaneously.
-
-
----
-
-This document is aimed at backend and frontend developers managing and extending the Genie platform's environment and team settings system. It should serve as a guide for understanding configuration storage, validation, API design, and usage patterns for consistent, reliable environment configuration handling.