evo360-types 1.3.249 → 1.3.258

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export * from "./types/firebase/pubsub-sync";
 export * from "./types/evo-core";
 export * from "./types/evo-tenant";
 export * from "./types/evo-activity";
+export * from "./types/evo-log";
 export * from "./types/evo-people";
 export * from "./types/evo-crm/dic";
 export * from "./types/evo-crm/lead";

package/dist/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./types/firebase/pubsub-sync"), exports);
 __exportStar(require("./types/evo-core"), exports);
 __exportStar(require("./types/evo-tenant"), exports);
 __exportStar(require("./types/evo-activity"), exports);
+__exportStar(require("./types/evo-log"), exports);
 __exportStar(require("./types/evo-people"), exports);
 __exportStar(require("./types/evo-crm/dic"), exports);
 __exportStar(require("./types/evo-crm/lead"), exports);

package/dist/index.ts

@@ -4,6 +4,7 @@ export * from "./types/firebase/pubsub-sync";
 export * from "./types/evo-core";
 export * from "./types/evo-tenant";
 export * from "./types/evo-activity";
+export * from "./types/evo-log";
 export * from "./types/evo-people";
 export * from "./types/evo-crm/dic";
 export * from "./types/evo-crm/lead";

package/dist/types/evo-log/evo-log-event.d.ts

@@ -0,0 +1,70 @@
+/** Who performed the action (or integration/system). */
+export declare enum EvoLogActorType {
+    User = "user",
+    System = "system",
+    Integration = "integration"
+}
+export declare enum EvoLogStatus {
+    Success = "success",
+    Error = "error"
+}
+/** Entrypoint kind for request metadata. */
+export declare enum EvoLogRequestMethod {
+    OnCall = "onCall",
+    OnRequest = "onRequest"
+}
+export interface IEvoLogActor {
+    type: EvoLogActorType;
+    userId: string | null;
+    loginId: string | null;
+}
+export interface IEvoLogRequestMeta {
+    ip: string | null;
+    userAgent: string | null;
+    method: EvoLogRequestMethod;
+    requestId: string | null;
+}
+export interface IEvoLogTarget {
+    entityType?: string | null;
+    entityId?: string | null;
+    tenantScopedPath?: string | null;
+}
+export interface IEvoLogError {
+    code?: string | null;
+    message?: string | null;
+}
+export interface IEvoLogResultSummary {
+    summary?: string | null;
+    changedFields?: string[] | null;
+}
+/**
+ * JSON string used for flexible fields in BigQuery sinks.
+ * Prefer `null` when absent (avoid the literal string `"null"`).
+ */
+export type EvoLogJsonString = string;
+/**
+ * Canonical audit event payload published to {@link EvoLogEventsPubSubTopic}.
+ * `params` must follow a per-endpoint whitelist (no full raw payloads).
+ */
+export interface IEvoLogEvent {
+    eventId: string;
+    occurredAt: string;
+    tenant: string | null;
+    module: string;
+    action: string;
+    functionName: string;
+    status: EvoLogStatus;
+    actor: IEvoLogActor;
+    request: IEvoLogRequestMeta;
+    target?: IEvoLogTarget | null;
+    /**
+     * Whitelisted parameters as JSON string (sink-friendly).
+     */
+    params: EvoLogJsonString | null;
+    /**
+     * Optional result summary as JSON string (sink-friendly).
+     */
+    result?: EvoLogJsonString | null;
+    error?: IEvoLogError | null;
+    labels?: Record<string, string>;
+}

package/dist/types/evo-log/evo-log-event.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EvoLogRequestMethod = exports.EvoLogStatus = exports.EvoLogActorType = void 0;
+/** Who performed the action (or integration/system). */
+var EvoLogActorType;
+(function (EvoLogActorType) {
+    EvoLogActorType["User"] = "user";
+    EvoLogActorType["System"] = "system";
+    EvoLogActorType["Integration"] = "integration";
+})(EvoLogActorType || (exports.EvoLogActorType = EvoLogActorType = {}));
+var EvoLogStatus;
+(function (EvoLogStatus) {
+    EvoLogStatus["Success"] = "success";
+    EvoLogStatus["Error"] = "error";
+})(EvoLogStatus || (exports.EvoLogStatus = EvoLogStatus = {}));
+/** Entrypoint kind for request metadata. */
+var EvoLogRequestMethod;
+(function (EvoLogRequestMethod) {
+    EvoLogRequestMethod["OnCall"] = "onCall";
+    EvoLogRequestMethod["OnRequest"] = "onRequest";
+})(EvoLogRequestMethod || (exports.EvoLogRequestMethod = EvoLogRequestMethod = {}));

package/dist/types/evo-log/evo-log-event.ts

@@ -0,0 +1,79 @@
+/** Who performed the action (or integration/system). */
+export enum EvoLogActorType {
+  User = "user",
+  System = "system",
+  Integration = "integration",
+}
+
+export enum EvoLogStatus {
+  Success = "success",
+  Error = "error",
+}
+
+/** Entrypoint kind for request metadata. */
+export enum EvoLogRequestMethod {
+  OnCall = "onCall",
+  OnRequest = "onRequest",
+}
+
+export interface IEvoLogActor {
+  type: EvoLogActorType;
+  userId: string | null;
+  loginId: string | null;
+}
+
+export interface IEvoLogRequestMeta {
+  ip: string | null;
+  userAgent: string | null;
+  method: EvoLogRequestMethod;
+  requestId: string | null;
+}
+
+export interface IEvoLogTarget {
+  entityType?: string | null;
+  entityId?: string | null;
+  tenantScopedPath?: string | null;
+}
+
+export interface IEvoLogError {
+  code?: string | null;
+  message?: string | null;
+}
+
+export interface IEvoLogResultSummary {
+  summary?: string | null;
+  changedFields?: string[] | null;
+}
+
+/**
+ * JSON string used for flexible fields in BigQuery sinks.
+ * Prefer `null` when absent (avoid the literal string `"null"`).
+ */
+export type EvoLogJsonString = string;
+
+/**
+ * Canonical audit event payload published to {@link EvoLogEventsPubSubTopic}.
+ * `params` must follow a per-endpoint whitelist (no full raw payloads).
+ */
+export interface IEvoLogEvent {
+  eventId: string;
+  occurredAt: string;
+  tenant: string | null;
+  module: string;
+  action: string;
+  functionName: string;
+  status: EvoLogStatus;
+  actor: IEvoLogActor;
+  request: IEvoLogRequestMeta;
+  target?: IEvoLogTarget | null;
+  /**
+   * Whitelisted parameters as JSON string (sink-friendly).
+   */
+  params: EvoLogJsonString | null;
+  /**
+   * Optional result summary as JSON string (sink-friendly).
+   */
+  result?: EvoLogJsonString | null;
+  error?: IEvoLogError | null;
+  labels?: Record<string, string>;
+}

package/dist/types/evo-log/fb_collections.d.ts

@@ -0,0 +1,6 @@
+/** Evo-Log application id (cross-cutting audit / activity stream). */
+export declare const EVO_LOG_APP = "evo-log";
+/** Logical collection name used in Pub/Sub topic naming (mirrors other apps). */
+export declare const EVO_LOG_ENTRIES_COLLECTION = "entries";
+/** Dedicated Pub/Sub topic for structured audit events (sink: BigQuery, etc.). */
+export declare const EvoLogEventsPubSubTopic = "app_evo-log_entries_events";

package/dist/types/evo-log/fb_collections.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EvoLogEventsPubSubTopic = exports.EVO_LOG_ENTRIES_COLLECTION = exports.EVO_LOG_APP = void 0;
+/** Evo-Log application id (cross-cutting audit / activity stream). */
+exports.EVO_LOG_APP = "evo-log";
+/** Logical collection name used in Pub/Sub topic naming (mirrors other apps). */
+exports.EVO_LOG_ENTRIES_COLLECTION = "entries";
+/** Dedicated Pub/Sub topic for structured audit events (sink: BigQuery, etc.). */
+exports.EvoLogEventsPubSubTopic = `app_${exports.EVO_LOG_APP}_${exports.EVO_LOG_ENTRIES_COLLECTION}_events`;

package/dist/types/evo-log/fb_collections.ts

@@ -0,0 +1,8 @@
+/** Evo-Log application id (cross-cutting audit / activity stream). */
+export const EVO_LOG_APP = "evo-log";
+
+/** Logical collection name used in Pub/Sub topic naming (mirrors other apps). */
+export const EVO_LOG_ENTRIES_COLLECTION = "entries";
+
+/** Dedicated Pub/Sub topic for structured audit events (sink: BigQuery, etc.). */
+export const EvoLogEventsPubSubTopic = `app_${EVO_LOG_APP}_${EVO_LOG_ENTRIES_COLLECTION}_events`;

package/dist/types/evo-log/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./fb_collections";
+export * from "./evo-log-event";

package/dist/types/evo-log/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./fb_collections"), exports);
+__exportStar(require("./evo-log-event"), exports);

package/dist/types/evo-log/index.ts

@@ -0,0 +1,2 @@
+export * from "./fb_collections";
+export * from "./evo-log-event";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "evo360-types",
-  "version": "1.3.249",
+  "version": "1.3.258",
   "description": "HREVO360 Shared Types",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",