cat-documents-ng 0.0.5 → 0.0.7

package/{src → projects/cat-document-lib/src}/lib/document/state/document.query.ts

@@ -1,23 +1,23 @@
-import { Injectable } from '@angular/core';
-import { QueryEntity } from '@datorama/akita';
-import { DocumentStore } from './document.store';
-import { DocumentState } from './document.state';
-
-/**
- * Service that provides querying capabilities for the `DocumentStore`.
- * 
- * The `DocumentQuery` class extends Akita's `QueryEntity`, allowing consumers
- * to retrieve, observe, and filter data from the `DocumentStore` in a reactive manner.
- * 
- * @extends QueryEntity<DocumentState>
- * * Creates an instance of `DocumentQuery`.
-   * 
-   * @param {DocumentStore} store - The underlying store that holds the document state.
-*/
-
-@Injectable({ providedIn: 'root' })
-export class DocumentQuery extends QueryEntity<DocumentState> {
-  constructor(protected override store: DocumentStore) {
-    super(store);
-  }
-}
+import { Injectable } from '@angular/core';
+import { QueryEntity } from '@datorama/akita';
+import { DocumentStore } from './document.store';
+import { DocumentState } from './document.state';
+
+/**
+ * Service that provides querying capabilities for the `DocumentStore`.
+ * 
+ * The `DocumentQuery` class extends Akita's `QueryEntity`, allowing consumers
+ * to retrieve, observe, and filter data from the `DocumentStore` in a reactive manner.
+ * 
+ * @extends QueryEntity<DocumentState>
+ * * Creates an instance of `DocumentQuery`.
+   * 
+   * @param {DocumentStore} store - The underlying store that holds the document state.
+*/
+
+@Injectable({ providedIn: 'root' })
+export class DocumentQuery extends QueryEntity<DocumentState> {
+  constructor(protected override store: DocumentStore) {
+    super(store);
+  }
+}

package/{src → projects/cat-document-lib/src}/lib/document/state/document.service.ts

@@ -1,95 +1,95 @@
-import { Injectable } from '@angular/core';
-import { HttpClient } from '@angular/common/http';
-import { DocumentStore } from './document.store';
-import { Observable, tap } from 'rxjs';
-import { AppConfigService } from '../../../Shared/services/app-config.service';
-import { URLS } from '../../../Shared/constant/URLS';
-import { DocumentModel } from '../models/document.model';
-
-/**
- * Service for managing document-related operations.
- * The `DocumentService` acts as a bridge between the application and the backend API for handling document-related data.
- * It interacts with the `DocumentStore` for state management and uses `HttpClient` for making HTTP requests.
- * Creates an instance of `DocumentService`.
- * @param {DocumentStore} documentStore - The store that manages the state of documents.
- * @param {HttpClient} http - The Angular HTTP client for making API requests.
- */
-@Injectable({ providedIn: 'root' })
-export class DocumentService {
-
-    /**
-     * Creates an instance of DocumentService.
-     * @param {DocumentStore} documentStore - Store managing the state of documents.
-     * @param {HttpClient} http - Angular HTTP client for making API requests.
-     * @param {AppConfigService} appConfigService - Service for retrieving application configuration, such as API base URL.
-     */
-    constructor(
-        public documentStore: DocumentStore,
-        private http: HttpClient,
-        public appConfigService: AppConfigService
-    ) { }
-
-    /**
-     * Get api url from appConfigService.
-     * @readonly
-     * @type {string}
-     */
-    get apiUrl(): string {
-        return this.appConfigService.apiBaseUrl;
-    }
-
-    /**
-     * Sends a request to create a new document.
-     * @param {*} entity - The data of the document to be created.
-     * @returns {Observable<any>} Observable that emits the newly created document.
-     */
-    create(entity: any): Observable<any> {
-        return this.http.post<any>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}`, entity).pipe(
-            tap((newEntity: any) => this.documentStore.add(newEntity))
-        );
-    }
-
-    /**
-     * Fetches all documents from the backend.
-     * @returns {Observable<DocumentModel[]>} Observable that emits an array of documents.
-     */
-    getAll(): Observable<DocumentModel[]> {
-        return this.http.get<DocumentModel[]>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}`).pipe(
-            tap((entities: DocumentModel[]) => this.documentStore.set(entities))
-        );
-    }
-
-    /**
-     * Fetches a document by its ID.
-     * @param {string} id - The unique identifier of the document.
-     * @returns {Observable<any>} Observable that emits the retrieved document.
-     */
-    getById(id: string): Observable<any> {
-        return this.http.get<any>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}/${id}`).pipe(
-            tap((entity: any) => this.documentStore.upsert(id, entity))
-        );
-    }
-
-    /**
-     * Updates an existing document by its ID.
-     * @param {string} id - The unique identifier of the document.
-     * @param {DocumentModel} entity - The updated data of the document.
-     * @returns {Observable<DocumentModel>} Observable that emits the updated document.
-     */
-    update(id: string, entity: DocumentModel): Observable<DocumentModel> {
-        return this.http.put<DocumentModel>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}/${id}`, entity).pipe(
-            tap((updatedEntity: DocumentModel) => this.documentStore.update(id, updatedEntity))
-        );
-    }
-
-    /**
-     * Deletes a document by its ID.
-     * @param {string} id - The unique identifier of the document to be deleted.
-     * @returns {Observable<void>} Observable that completes when the document is deleted.
-     */
-    delete(id: string): Observable<void> {
-        return this.http.delete<void>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}/${id}`).pipe(
-            tap(() => this.documentStore.remove(id))
-        );
-    }
-}
+import { Injectable } from '@angular/core';
+import { HttpClient } from '@angular/common/http';
+import { DocumentStore } from './document.store';
+import { Observable, tap } from 'rxjs';
+import { AppConfigService } from '../../../Shared/services/app-config.service';
+import { URLS } from '../../../Shared/constant/URLS';
+import { DocumentModel } from '../models/document.model';
+
+/**
+ * Service for managing document-related operations.
+ * The `DocumentService` acts as a bridge between the application and the backend API for handling document-related data.
+ * It interacts with the `DocumentStore` for state management and uses `HttpClient` for making HTTP requests.
+ * Creates an instance of `DocumentService`.
+ * @param {DocumentStore} documentStore - The store that manages the state of documents.
+ * @param {HttpClient} http - The Angular HTTP client for making API requests.
+ */
+@Injectable({ providedIn: 'root' })
+export class DocumentService {
+
+    /**
+     * Creates an instance of DocumentService.
+     * @param {DocumentStore} documentStore - Store managing the state of documents.
+     * @param {HttpClient} http - Angular HTTP client for making API requests.
+     * @param {AppConfigService} appConfigService - Service for retrieving application configuration, such as API base URL.
+     */
+    constructor(
+        public documentStore: DocumentStore,
+        private http: HttpClient,
+        public appConfigService: AppConfigService
+    ) { }
+
+    /**
+     * Get api url from appConfigService.
+     * @readonly
+     * @type {string}
+     */
+    get apiUrl(): string {
+        return this.appConfigService.apiBaseUrl;
+    }
+
+    /**
+     * Sends a request to create a new document.
+     * @param {*} entity - The data of the document to be created.
+     * @returns {Observable<any>} Observable that emits the newly created document.
+     */
+    create(entity: any): Observable<any> {
+        return this.http.post<any>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}`, entity).pipe(
+            tap((newEntity: any) => this.documentStore.add(newEntity))
+        );
+    }
+
+    /**
+     * Fetches all documents from the backend.
+     * @returns {Observable<DocumentModel[]>} Observable that emits an array of documents.
+     */
+    getAll(): Observable<DocumentModel[]> {
+        return this.http.get<DocumentModel[]>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}`).pipe(
+            tap((entities: DocumentModel[]) => this.documentStore.set(entities))
+        );
+    }
+
+    /**
+     * Fetches a document by its ID.
+     * @param {string} id - The unique identifier of the document.
+     * @returns {Observable<any>} Observable that emits the retrieved document.
+     */
+    getById(id: string): Observable<any> {
+        return this.http.get<any>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}/${id}`).pipe(
+            tap((entity: any) => this.documentStore.upsert(id, entity))
+        );
+    }
+
+    /**
+     * Updates an existing document by its ID.
+     * @param {string} id - The unique identifier of the document.
+     * @param {DocumentModel} entity - The updated data of the document.
+     * @returns {Observable<DocumentModel>} Observable that emits the updated document.
+     */
+    update(id: string, entity: DocumentModel): Observable<DocumentModel> {
+        return this.http.put<DocumentModel>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}/${id}`, entity).pipe(
+            tap((updatedEntity: DocumentModel) => this.documentStore.update(id, updatedEntity))
+        );
+    }
+
+    /**
+     * Deletes a document by its ID.
+     * @param {string} id - The unique identifier of the document to be deleted.
+     * @returns {Observable<void>} Observable that completes when the document is deleted.
+     */
+    delete(id: string): Observable<void> {
+        return this.http.delete<void>(`${this.apiUrl}${URLS.DOCUMENT_UPLOAD}/${id}`).pipe(
+            tap(() => this.documentStore.remove(id))
+        );
+    }
+}

package/{src → projects/cat-document-lib/src}/lib/document/state/document.state.ts

@@ -1,39 +1,39 @@
-import { EntityState } from '@datorama/akita';
-import { DocumentModel } from '../models/document.model';
-
-/**
- * Represents the state of the documents in the application.
- * 
- * This interface extends Akita's `EntityState` to include additional properties
- * for managing document-specific data, such as `records`, `filteredRecords` and `folderId`.
- * 
- * @extends EntityState<DocumentModel, string>
- * 
- * @property {any[]} records - A collection of records related to documents.
- * @property {any[]} filteredRecords - A collection of filteredRecords related to documents.
- * @property {string | null} folderId - The ID of the currently selected folder, or `null` if no folder is selected.
- * @property {boolean} isDialogOpen - A flag indicating whether a dialog is open.
- */
-export interface DocumentState extends EntityState<DocumentModel, string> {
-  records: DocumentModel[];
-  folderId: string | null;
-  isDialogOpen: boolean;
-  filteredRecords:DocumentModel[]
-}
-
-/**
- * Creates the initial state for the `DocumentState` store.
- * 
- * This function provides default values for all properties in the `DocumentState` interface,
- * ensuring the store starts with a consistent initial structure.
- * 
- * @returns {DocumentState} The initial state of the document store.
- */
-export function createInitialState(): DocumentState {
-  return {
-    records: [],
-    filteredRecords: [],
-    folderId: null,
-    isDialogOpen: false,
-  };
-}
+import { EntityState } from '@datorama/akita';
+import { DocumentModel } from '../models/document.model';
+
+/**
+ * Represents the state of the documents in the application.
+ * 
+ * This interface extends Akita's `EntityState` to include additional properties
+ * for managing document-specific data, such as `records`, `filteredRecords` and `folderId`.
+ * 
+ * @extends EntityState<DocumentModel, string>
+ * 
+ * @property {any[]} records - A collection of records related to documents.
+ * @property {any[]} filteredRecords - A collection of filteredRecords related to documents.
+ * @property {string | null} folderId - The ID of the currently selected folder, or `null` if no folder is selected.
+ * @property {boolean} isDialogOpen - A flag indicating whether a dialog is open.
+ */
+export interface DocumentState extends EntityState<DocumentModel, string> {
+  records: DocumentModel[];
+  folderId: string | null;
+  isDialogOpen: boolean;
+  filteredRecords:DocumentModel[]
+}
+
+/**
+ * Creates the initial state for the `DocumentState` store.
+ * 
+ * This function provides default values for all properties in the `DocumentState` interface,
+ * ensuring the store starts with a consistent initial structure.
+ * 
+ * @returns {DocumentState} The initial state of the document store.
+ */
+export function createInitialState(): DocumentState {
+  return {
+    records: [],
+    filteredRecords: [],
+    folderId: null,
+    isDialogOpen: false,
+  };
+}

package/{src → projects/cat-document-lib/src}/lib/document/state/document.store.ts

@@ -1,23 +1,23 @@
-import { Injectable } from '@angular/core';
-import { EntityStore, StoreConfig } from '@datorama/akita';
-import { createInitialState, DocumentState } from './document.state';
-
-/**
- * Store that manages the state of documents in the application.
- * 
- * The `DocumentStore` class extends Akita's `EntityStore` to manage the entity state for documents.
- * It uses the `createInitialState` function to initialize the store with default values and 
- * is configured with the name `'documents'`.
- * 
- * @extends EntityStore<DocumentState>
- */
-@Injectable({ providedIn: 'root' })
-@StoreConfig({ name: 'documents' })
-export class DocumentStore extends EntityStore<DocumentState> {
-  /**
-   * Creates an instance of `DocumentStore` with the initial state of the documents.
-   */
-  constructor() {
-    super(createInitialState());
-  }
-}
+import { Injectable } from '@angular/core';
+import { EntityStore, StoreConfig } from '@datorama/akita';
+import { createInitialState, DocumentState } from './document.state';
+
+/**
+ * Store that manages the state of documents in the application.
+ * 
+ * The `DocumentStore` class extends Akita's `EntityStore` to manage the entity state for documents.
+ * It uses the `createInitialState` function to initialize the store with default values and 
+ * is configured with the name `'documents'`.
+ * 
+ * @extends EntityStore<DocumentState>
+ */
+@Injectable({ providedIn: 'root' })
+@StoreConfig({ name: 'documents' })
+export class DocumentStore extends EntityStore<DocumentState> {
+  /**
+   * Creates an instance of `DocumentStore` with the initial state of the documents.
+   */
+  constructor() {
+    super(createInitialState());
+  }
+}

package/{src → projects/cat-document-lib/src}/public-api.ts

@@ -1,8 +1,8 @@
-/*
- * Public API Surface of cat-document-lib
- */
-
-export * from './lib/document/document.module';
-export * from './lib/document/components/document-container/document-container.component';
-export * from './lib/document/components/document-viewer/document-viewer.component'
-
+/*
+ * Public API Surface of cat-document-lib
+ */
+
+export * from './lib/document/document.module';
+export * from './lib/document/components/document-container/document-container.component';
+export * from './lib/document/components/document-viewer/document-viewer.component'
+

package/{tsconfig.lib.json → projects/cat-document-lib/tsconfig.lib.json}

@@ -1,15 +1,15 @@
-/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
-/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../out-tsc/lib",
-    "declaration": true,
-    "declarationMap": true,
-    "inlineSources": true,
-    "types": []
-  },
-  "exclude": [
-    "**/*.spec.ts"
-  ]
-}
+/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
+/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../out-tsc/lib",
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "types": []
+  },
+  "exclude": [
+    "**/*.spec.ts"
+  ]
+}

package/{tsconfig.lib.prod.json → projects/cat-document-lib/tsconfig.lib.prod.json}

@@ -1,11 +1,11 @@
-/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
-/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
-{
-  "extends": "./tsconfig.lib.json",
-  "compilerOptions": {
-    "declarationMap": false
-  },
-  "angularCompilerOptions": {
-    "compilationMode": "partial"
-  }
-}
+/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
+/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
+{
+  "extends": "./tsconfig.lib.json",
+  "compilerOptions": {
+    "declarationMap": false
+  },
+  "angularCompilerOptions": {
+    "compilationMode": "partial"
+  }
+}

package/{tsconfig.spec.json → projects/cat-document-lib/tsconfig.spec.json}

@@ -1,15 +1,15 @@
-/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
-/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../out-tsc/spec",
-    "types": [
-      "jest"
-    ]
-  },
-  "include": [
-    "**/*.spec.ts",
-    "**/*.d.ts"
-  ]
-}
+/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
+/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../out-tsc/spec",
+    "types": [
+      "jest"
+    ]
+  },
+  "include": [
+    "**/*.spec.ts",
+    "**/*.d.ts"
+  ]
+}

package/src/app/app.component.html

@@ -0,0 +1 @@
+<lib-document-container></lib-document-container>

package/src/app/app.component.spec.ts

@@ -0,0 +1,29 @@
+import { TestBed } from '@angular/core/testing';
+import { AppComponent } from './app.component';
+
+describe('AppComponent', () => {
+  beforeEach(async () => {
+    await TestBed.configureTestingModule({
+      imports: [AppComponent],
+    }).compileComponents();
+  });
+
+  it('should create the app', () => {
+    const fixture = TestBed.createComponent(AppComponent);
+    const app = fixture.componentInstance;
+    expect(app).toBeTruthy();
+  });
+
+  it(`should have the 'cat-documents-ng' title`, () => {
+    const fixture = TestBed.createComponent(AppComponent);
+    const app = fixture.componentInstance;
+    expect(app.title).toEqual('cat-documents-ng');
+  });
+
+  it('should render title', () => {
+    const fixture = TestBed.createComponent(AppComponent);
+    fixture.detectChanges();
+    const compiled = fixture.nativeElement as HTMLElement;
+    expect(compiled.querySelector('h1')?.textContent).toContain('Hello, cat-documents-ng');
+  });
+});

package/src/app/app.component.ts

@@ -0,0 +1,15 @@
+import { Component } from '@angular/core';
+import { RouterOutlet } from '@angular/router';
+
+/**
+ *
+ */
+@Component({
+  selector: 'app-root',
+  standalone : false,
+  templateUrl: './app.component.html',
+  styleUrl: './app.component.scss'
+})
+export class AppComponent {
+  title = 'cat-documents-ng';
+}

package/src/app/app.module.ts

@@ -0,0 +1,60 @@
+import { APP_INITIALIZER, NgModule } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { AppRoutingModule } from './app.routing.module';
+import { AppComponent } from './app.component';
+import { BrowserModule } from '@angular/platform-browser';
+import { DocumentModule } from '../../projects/cat-document-lib/src/public-api';
+import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
+import { AppConfigService } from '../../projects/cat-document-lib/src/Shared/services/app-config.service';
+import { GlobalErrorHandler } from '../../projects/cat-document-lib/src/Shared/services/global-error.handler';
+
+/**
+ * The root module of the Angular application.
+ *
+ * The `AppModule` is the starting point of the application, declaring the main application component,
+ * importing necessary Angular modules, and bootstrapping the root component.
+ */
+@NgModule({
+  declarations: [
+    /**
+     * Declares the main application component.
+     */
+    AppComponent
+  ],
+  imports: [
+    /**
+     * Provides Angular's commonly needed directives and pipes.
+     */
+    CommonModule,
+    /**
+     * Handles routing configuration for the application.
+     */
+    AppRoutingModule,
+    /**
+     * Provides essential Angular services for browser-based applications.
+     */
+    BrowserModule,
+    /**
+     * Imports the custom DocumentModule, which contains document-related features.
+     */
+    DocumentModule,
+    /**
+     * Enables animations for Angular components in the application.
+     */
+    BrowserAnimationsModule
+  ],
+  bootstrap: [
+    /**
+     * Specifies the root component to bootstrap the application.
+     */
+    AppComponent
+  ],
+  providers: [
+    /**
+     * Registers the global error handler for the application.
+     */
+   
+  ]
+  
+})
+export class AppModule {}

package/src/app/app.routing.module.ts

@@ -0,0 +1,19 @@
+import { NgModule } from '@angular/core';
+import { RouterModule, Routes } from '@angular/router';
+import { AppComponent } from './app.component';
+
+const routes: Routes = [
+  {
+    path : "",
+    component : AppComponent
+  }
+];
+
+/**
+ *
+ */
+@NgModule({
+  imports: [RouterModule.forChild(routes)],
+  exports: [RouterModule]
+})
+export class AppRoutingModule { }

package/src/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>CatDocumentsNg</title>
+  <base href="/">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="icon" type="image/x-icon" href="favicon.ico">
+</head>
+<body>
+  <app-root></app-root>
+</body>
+</html>

package/src/main.ts

@@ -0,0 +1,5 @@
+import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+import { AppModule } from './app/app.module';
+
+platformBrowserDynamic().bootstrapModule(AppModule)
+  .catch(err => console.error(err));