@en-solutions/tgm-client-sdk 1.7.0 → 1.8.0

package/lib/models/admin/erp.models.d.ts

@@ -76,6 +76,8 @@ export interface ErpEntityMappingRequest {
     conflictResolution?: string;
     syncFilter?: Record<string, any>;
     fieldMappings?: FieldMappingRequest[];
+    /** When tgmEntityType=CUSTOM, the CMS collection name to sync to */
+    customCollectionName?: string;
 }
 export interface FieldMappingRequest {
     tgmFieldName: string;

package/lib/models/api/cms.models.d.ts

@@ -0,0 +1,166 @@
+export interface ContentTypeSchema {
+    kind?: string;
+    collectionName: string;
+    info: {
+        singularName: string;
+        pluralName: string;
+        displayName: string;
+        description?: string;
+    };
+    options?: {
+        draftAndPublish?: boolean;
+    };
+    attributes: Record<string, FieldDefinition>;
+}
+export interface FieldDefinition {
+    name: string;
+    type: 'string' | 'text' | 'richtext' | 'integer' | 'biginteger' | 'float' | 'decimal' | 'boolean' | 'date' | 'time' | 'datetime' | 'json' | 'enumeration' | 'email' | 'media' | 'relation';
+    required?: boolean;
+    unique?: boolean;
+    private?: boolean;
+    default?: any;
+    minLength?: number;
+    maxLength?: number;
+    min?: number;
+    max?: number;
+    regex?: string;
+    enum?: string[];
+    relation?: 'oneToOne' | 'oneToMany' | 'manyToOne' | 'manyToMany';
+    target?: string;
+    allowedTypes?: string[];
+    multiple?: boolean;
+}
+export interface CmsSavedView {
+    id?: number;
+    collectionName?: string;
+    userId?: number;
+    viewName: string;
+    isDefault?: boolean;
+    filterConfig?: Record<string, any>;
+    columnConfig?: string[];
+    sortConfig?: {
+        field: string;
+        order: 'ASC' | 'DESC';
+    };
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CmsValidationRule {
+    id?: number;
+    collectionName?: string;
+    ruleName: string;
+    ruleType: 'REQUIRED_IF' | 'COMPARISON' | 'REGEX' | 'CUSTOM_EXPRESSION';
+    ruleConfig: Record<string, any>;
+    errorMessage: string;
+    isActive?: boolean;
+    displayOrder?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CmsRecordType {
+    id?: number;
+    collectionName?: string;
+    typeName: string;
+    displayName: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    isDefault?: boolean;
+    isActive?: boolean;
+    fieldOverrides?: Record<string, any>;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CmsPageLayout {
+    id?: number;
+    collectionName?: string;
+    layoutName: string;
+    isDefault?: boolean;
+    recordTypeId?: number;
+    sections: CmsLayoutSection[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface CmsLayoutSection {
+    title: string;
+    columns: number;
+    fields: string[];
+}
+export interface CmsFormulaField {
+    id?: number;
+    collectionName?: string;
+    fieldName: string;
+    label: string;
+    formula: string;
+    resultType: 'NUMBER' | 'STRING' | 'DATE' | 'BOOLEAN';
+    displayOrder?: number;
+    isActive?: boolean;
+    createdAt?: string;
+}
+export interface CmsWorkflowRule {
+    id?: number;
+    collectionName?: string;
+    ruleName: string;
+    triggerEvent: 'ON_CREATE' | 'ON_UPDATE' | 'ON_CREATE_OR_UPDATE';
+    isActive?: boolean;
+    evaluationOrder?: number;
+    conditionConfig?: Record<string, any>;
+    actions: CmsWorkflowAction[];
+    createdAt?: string;
+}
+export interface CmsWorkflowAction {
+    type: 'FIELD_UPDATE' | 'NOTIFICATION' | 'LOG';
+    field?: string;
+    value?: any;
+    message?: string;
+}
+export interface CmsApprovalProcess {
+    id?: number;
+    collectionName?: string;
+    processName: string;
+    isActive?: boolean;
+    triggerField: string;
+    triggerValue: string;
+    finalApproveValue?: string;
+    finalRejectValue?: string;
+    steps: CmsApprovalStep[];
+    notifyOnSubmit?: boolean;
+    notifyOnApprove?: boolean;
+    notifyOnReject?: boolean;
+    createdAt?: string;
+}
+export interface CmsApprovalStep {
+    order: number;
+    name: string;
+    approverField?: string;
+    approverRole?: string;
+}
+export interface CmsApprovalInstance {
+    id?: number;
+    processId: number;
+    collectionName?: string;
+    recordId: number;
+    currentStep?: number;
+    status?: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELLED';
+    submittedBy?: number;
+    submittedAt?: string;
+    completedAt?: string;
+    comments?: string;
+    stepHistory?: any[];
+}
+export interface CmsRollupResult {
+    result: any;
+    function: string;
+    targetCollection: string;
+}
+export interface CmsDataResponse<T = any> {
+    data: T;
+    meta?: {
+        pagination?: {
+            page: number;
+            pageSize: number;
+            pageCount: number;
+            total: number;
+        };
+    };
+}

package/lib/models/enums/erp.enums.d.ts

@@ -40,10 +40,23 @@ export declare const TgmEntityType: {
     readonly LOCATION: "LOCATION";
     readonly UNIT: "UNIT";
     readonly COMPONENT: "COMPONENT";
+    readonly SENSOR: "SENSOR";
+    readonly SENSOR_READING: "SENSOR_READING";
     readonly USER: "USER";
     readonly INSPECTION: "INSPECTION";
+    readonly MAINTENANCE_RECORD: "MAINTENANCE_RECORD";
+    readonly MAINTENANCE_PLAN: "MAINTENANCE_PLAN";
     readonly FAILURE: "FAILURE";
+    readonly MATERIAL_ITEM: "MATERIAL_ITEM";
+    readonly MATERIAL_CONSUMABLE: "MATERIAL_CONSUMABLE";
+    readonly SUPPLIER: "SUPPLIER";
     readonly INVENTORY: "INVENTORY";
     readonly INVOICE: "INVOICE";
+    readonly PURCHASE_ORDER: "PURCHASE_ORDER";
+    readonly GOODS_RECEIPT: "GOODS_RECEIPT";
+    readonly STOCK_MOVEMENT: "STOCK_MOVEMENT";
+    readonly WAREHOUSE: "WAREHOUSE";
+    readonly STOCK_COUNT: "STOCK_COUNT";
+    readonly CUSTOM: "CUSTOM";
 };
 export type TgmEntityType = (typeof TgmEntityType)[keyof typeof TgmEntityType];

package/lib/services/api/cms-menu.helper.d.ts

@@ -0,0 +1,88 @@
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * Menu item structure matching tgm-manager-ui's CoreMenuItem interface.
+ * Frontend devs can inject these into the sidebar dynamically.
+ *
+ * Usage in tgm-manager-ui:
+ *
+ * ```typescript
+ * // In AppComponent or a module initializer:
+ * cmsMenuHelper.getMenuItems('administration/cms').subscribe(items => {
+ *   // items is a CoreMenuItem[] array ready to inject into the sidebar
+ *   const adminSection = menu.find(m => m.id === 'administration');
+ *   const cmsGroup = {
+ *     id: 'custom-objects',
+ *     type: 'section' as const,
+ *     title: 'Custom Objects',
+ *     icon: 'layers',
+ *     role: [Role['Administration.Read']],
+ *     children: items
+ *   };
+ *   const moreIdx = adminSection.children.findIndex(c => c.id === 'more');
+ *   adminSection.children.splice(moreIdx, 0, cmsGroup);
+ * });
+ * ```
+ *
+ * Route setup in administraton.module.ts:
+ * ```typescript
+ * {
+ *   path: 'cms/:collectionName',
+ *   loadChildren: () => import('./cms/cms.module').then(m => m.CmsModule),
+ *   canActivate: [AuthGuard]
+ * }
+ * ```
+ */
+export declare class CmsMenuHelper {
+    private contentTypeService;
+    /**
+     * Fetch all active content types and transform them into menu items.
+     *
+     * @param baseUrl - The base route path (e.g., 'administration/cms')
+     * @param defaultIcon - Default icon for items without a specific one (default: 'database')
+     * @returns Observable of menu items array
+     */
+    getMenuItems(baseUrl?: string, defaultIcon?: string): Observable<CmsMenuItem[]>;
+    /**
+     * Transform a single content type into a menu item.
+     */
+    private toMenuItem;
+    /**
+     * Build a complete "Custom Objects" collapsible menu section.
+     * Ready to inject directly into the sidebar menu array.
+     *
+     * @param baseUrl - Route base path
+     * @param roles - Required roles to see this section
+     */
+    getMenuSection(baseUrl?: string, roles?: string[]): Observable<CmsMenuSection>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CmsMenuHelper, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CmsMenuHelper>;
+}
+/**
+ * Menu item structure compatible with tgm-manager-ui's CoreMenuItem.
+ */
+export interface CmsMenuItem {
+    id: string;
+    title: string;
+    type: 'item' | 'section' | 'collapsible';
+    icon?: string;
+    url?: string;
+    role?: string[];
+    translate?: string;
+    hidden?: boolean;
+    disabled?: boolean;
+    availableOnMobileNative?: boolean;
+    mobileOnly?: boolean;
+    badge?: {
+        title?: string;
+        translate?: string;
+        classes?: string;
+    };
+    children?: CmsMenuItem[];
+}
+/**
+ * Complete menu section ready for sidebar injection.
+ */
+export interface CmsMenuSection extends CmsMenuItem {
+    children: CmsMenuItem[];
+}

package/lib/services/api/cms.service.d.ts

@@ -0,0 +1,83 @@
+import { Observable } from 'rxjs';
+import { TgmHttpClient } from '../../core/http-client.service';
+import { ContentTypeSchema, CmsSavedView, CmsValidationRule, CmsRecordType, CmsPageLayout, CmsDataResponse } from '../../models/api/cms.models';
+import * as i0 from "@angular/core";
+export declare class CmsContentTypeService {
+    private http;
+    private basePath;
+    constructor(http: TgmHttpClient);
+    getAll(): Observable<ContentTypeSchema[]>;
+    get(collectionName: string): Observable<ContentTypeSchema>;
+    getCount(): Observable<{
+        count: number;
+    }>;
+    create(schema: Partial<ContentTypeSchema> & {
+        collectionName: string;
+        attributes: Record<string, any>;
+    }): Observable<any>;
+    delete(collectionName: string): Observable<any>;
+    syncMigrations(): Observable<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CmsContentTypeService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CmsContentTypeService>;
+}
+export declare class CmsDataService {
+    private http;
+    private basePath;
+    constructor(http: TgmHttpClient);
+    list(collectionName: string, params?: {
+        page?: number;
+        pageSize?: number;
+        sort?: string;
+        order?: string;
+    }): Observable<CmsDataResponse<any[]>>;
+    get(collectionName: string, id: number): Observable<CmsDataResponse>;
+    create(collectionName: string, data: Record<string, any>): Observable<CmsDataResponse>;
+    update(collectionName: string, id: number, data: Record<string, any>): Observable<CmsDataResponse>;
+    delete(collectionName: string, id: number): Observable<any>;
+    bulkDelete(collectionName: string, ids: number[]): Observable<any>;
+    count(collectionName: string): Observable<{
+        count: number;
+    }>;
+    search(collectionName: string, filters: Record<string, any>, params?: {
+        page?: number;
+        pageSize?: number;
+        sort?: string;
+        order?: string;
+    }): Observable<CmsDataResponse<any[]>>;
+    publish(collectionName: string, id: number): Observable<CmsDataResponse>;
+    unpublish(collectionName: string, id: number): Observable<CmsDataResponse>;
+    exportCsv(collectionName: string, columns?: string[]): Observable<string>;
+    listViews(collectionName: string): Observable<CmsDataResponse<CmsSavedView[]>>;
+    createView(collectionName: string, view: Partial<CmsSavedView>): Observable<CmsDataResponse<CmsSavedView>>;
+    updateView(collectionName: string, viewId: number, update: Partial<CmsSavedView>): Observable<CmsDataResponse<CmsSavedView>>;
+    deleteView(collectionName: string, viewId: number): Observable<any>;
+    listValidationRules(collectionName: string, activeOnly?: boolean): Observable<CmsDataResponse<CmsValidationRule[]>>;
+    createValidationRule(collectionName: string, rule: Partial<CmsValidationRule>): Observable<CmsDataResponse<CmsValidationRule>>;
+    updateValidationRule(collectionName: string, ruleId: number, update: Partial<CmsValidationRule>): Observable<CmsDataResponse<CmsValidationRule>>;
+    deleteValidationRule(collectionName: string, ruleId: number): Observable<any>;
+    listRecordTypes(collectionName: string, activeOnly?: boolean): Observable<CmsDataResponse<CmsRecordType[]>>;
+    createRecordType(collectionName: string, recordType: Partial<CmsRecordType>): Observable<CmsDataResponse<CmsRecordType>>;
+    updateRecordType(collectionName: string, typeId: number, update: Partial<CmsRecordType>): Observable<CmsDataResponse<CmsRecordType>>;
+    deleteRecordType(collectionName: string, typeId: number): Observable<any>;
+    listLayouts(collectionName: string): Observable<CmsDataResponse<CmsPageLayout[]>>;
+    createLayout(collectionName: string, layout: Partial<CmsPageLayout>): Observable<CmsDataResponse<CmsPageLayout>>;
+    updateLayout(collectionName: string, layoutId: number, update: Partial<CmsPageLayout>): Observable<CmsDataResponse<CmsPageLayout>>;
+    deleteLayout(collectionName: string, layoutId: number): Observable<any>;
+    listFormulas(collectionName: string, activeOnly?: boolean): Observable<CmsDataResponse<any[]>>;
+    createFormula(collectionName: string, formula: any): Observable<CmsDataResponse<any>>;
+    updateFormula(collectionName: string, formulaId: number, update: any): Observable<CmsDataResponse<any>>;
+    deleteFormula(collectionName: string, formulaId: number): Observable<any>;
+    listWorkflows(collectionName: string, activeOnly?: boolean): Observable<CmsDataResponse<any[]>>;
+    createWorkflow(collectionName: string, workflow: any): Observable<CmsDataResponse<any>>;
+    updateWorkflow(collectionName: string, workflowId: number, update: any): Observable<CmsDataResponse<any>>;
+    deleteWorkflow(collectionName: string, workflowId: number): Observable<any>;
+    listApprovalProcesses(collectionName: string): Observable<CmsDataResponse<any[]>>;
+    createApprovalProcess(collectionName: string, process: any): Observable<CmsDataResponse<any>>;
+    deleteApprovalProcess(collectionName: string, processId: number): Observable<any>;
+    getApprovalStatus(collectionName: string, recordId: number): Observable<CmsDataResponse<any[]>>;
+    submitForApproval(collectionName: string, recordId: number, processId: number): Observable<CmsDataResponse<any>>;
+    approvalAction(collectionName: string, instanceId: number, action: 'APPROVE' | 'REJECT', comment?: string): Observable<CmsDataResponse<any>>;
+    rollup(collectionName: string, targetCollection: string, fkField: string, parentId: number, fn?: string, aggregateField?: string): Observable<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CmsDataService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CmsDataService>;
+}

package/lib/services/api/index.d.ts

@@ -99,3 +99,5 @@ export { ScheduledReportService } from './scheduled-report.service';
 export { EntityCommentService } from './entity-comment.service';
 export { AuditEntryService } from './audit-entry.service';
 export { ThresholdAlertRuleService } from './threshold-alert-rule.service';
+export { CmsContentTypeService, CmsDataService } from './cms.service';
+export { CmsMenuHelper, CmsMenuItem, CmsMenuSection } from './cms-menu.helper';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@en-solutions/tgm-client-sdk",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "TGM Manager Client SDK for Angular 18 - Type-safe services for all TGM API endpoints",
   "license": "SEE LICENSE IN LICENSE",
   "repository": {
@@ -8,8 +8,7 @@
     "url": "https://github.com/EN-Solutions/tgm-client-sdk.git"
   },
   "publishConfig": {
-    "registry": "https://registry.npmjs.org",
-    "access": "public"
+    "registry": "https://npm.pkg.github.com"
   },
   "peerDependencies": {
     "@angular/common": "^18.0.0",