@memberjunction/integration-ui-types 0.0.1 → 5.8.0

package/README.md

@@ -1,45 +1,25 @@
 # @memberjunction/integration-ui-types
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+Lightweight, Angular-safe view model types for the MemberJunction Integration UI.
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+This package contains only TypeScript interfaces and type aliases with zero runtime dependencies. It is safe to import from Angular components, Node.js services, or any other TypeScript environment.
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+## Types
 
-## Purpose
+| Type | Description |
+|------|-------------|
+| `IntegrationSummary` | Overview of a company integration's current state |
+| `ConnectorHealth` | Health status union: `'Healthy' \| 'Degraded' \| 'Offline' \| 'Unknown'` |
+| `RunStatusSummary` | Summary of a single integration run |
+| `EntityMapSummary` | Entity map sync configuration summary |
+| `IntegrationDashboardStats` | Aggregate stats for dashboard overview |
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@memberjunction/integration-ui-types`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+## Usage
 
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+```typescript
+import type {
+  IntegrationSummary,
+  RunStatusSummary,
+  ConnectorHealth,
+} from '@memberjunction/integration-ui-types';
+```

package/dist/index.d.ts

@@ -0,0 +1,75 @@
+/** Summary of an integration's current state for UI display */
+export interface IntegrationSummary {
+    /** Company Integration ID */
+    CompanyIntegrationID: string;
+    /** Display name of the integration (e.g., "HubSpot", "Salesforce") */
+    IntegrationName: string;
+    /** Company name */
+    CompanyName: string;
+    /** Whether the integration is currently active */
+    IsActive: boolean;
+    /** Number of active entity maps configured */
+    EntityMapCount: number;
+    /** Timestamp of the last successful sync */
+    LastSyncAt: string | null;
+    /** Current connector health status */
+    Health: ConnectorHealth;
+}
+/** Health status of a connector */
+export type ConnectorHealth = 'Healthy' | 'Degraded' | 'Offline' | 'Unknown';
+/** Summary of a single integration run for UI display */
+export interface RunStatusSummary {
+    /** Run ID */
+    RunID: string;
+    /** Company Integration ID */
+    CompanyIntegrationID: string;
+    /** Integration display name */
+    IntegrationName: string;
+    /** Current run status */
+    Status: 'Pending' | 'In Progress' | 'Success' | 'Failed';
+    /** Who triggered the run */
+    RunByUser: string;
+    /** When the run started */
+    StartedAt: string;
+    /** When the run ended (null if still running) */
+    EndedAt: string | null;
+    /** Total records processed */
+    TotalRecords: number;
+    /** Records created */
+    RecordsCreated: number;
+    /** Records updated */
+    RecordsUpdated: number;
+    /** Records that had errors */
+    RecordsErrored: number;
+    /** Duration in seconds (computed on the client from StartedAt/EndedAt) */
+    DurationSeconds: number | null;
+}
+/** Summary of an entity map's sync configuration for UI display */
+export interface EntityMapSummary {
+    /** Entity Map ID */
+    EntityMapID: string;
+    /** External object name (e.g., "Contact") */
+    ExternalObjectName: string;
+    /** MJ Entity name */
+    MJEntityName: string;
+    /** Sync direction */
+    SyncDirection: 'Pull' | 'Push' | 'Bidirectional';
+    /** Whether sync is enabled */
+    SyncEnabled: boolean;
+    /** Number of active field maps */
+    FieldMapCount: number;
+    /** Last watermark value */
+    LastWatermarkValue: string | null;
+}
+/** Stats for the integration dashboard overview */
+export interface IntegrationDashboardStats {
+    /** Total number of active integrations */
+    ActiveIntegrations: number;
+    /** Total records synced across all integrations today */
+    RecordsSyncedToday: number;
+    /** Number of failed runs in the last 24 hours */
+    FailedRunsLast24h: number;
+    /** Next scheduled sync time */
+    NextScheduledSync: string | null;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,MAAM,WAAW,kBAAkB;IAC/B,6BAA6B;IAC7B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,sEAAsE;IACtE,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,QAAQ,EAAE,OAAO,CAAC;IAClB,8CAA8C;IAC9C,cAAc,EAAE,MAAM,CAAC;IACvB,4CAA4C;IAC5C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,sCAAsC;IACtC,MAAM,EAAE,eAAe,CAAC;CAC3B;AAED,mCAAmC;AACnC,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;AAE7E,yDAAyD;AACzD,MAAM,WAAW,gBAAgB;IAC7B,aAAa;IACb,KAAK,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,+BAA+B;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,yBAAyB;IACzB,MAAM,EAAE,SAAS,GAAG,aAAa,GAAG,SAAS,GAAG,QAAQ,CAAC;IACzD,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,8BAA8B;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,8BAA8B;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,0EAA0E;IAC1E,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,mEAAmE;AACnE,MAAM,WAAW,gBAAgB;IAC7B,oBAAoB;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,6CAA6C;IAC7C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,qBAAqB;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB;IACrB,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,eAAe,CAAC;IACjD,8BAA8B;IAC9B,WAAW,EAAE,OAAO,CAAC;IACrB,kCAAkC;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,2BAA2B;IAC3B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED,mDAAmD;AACnD,MAAM,WAAW,yBAAyB;IACtC,0CAA0C;IAC1C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,yDAAyD;IACzD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iDAAiD;IACjD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,+BAA+B;IAC/B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,10 +1,23 @@
 {
   "name": "@memberjunction/integration-ui-types",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @memberjunction/integration-ui-types",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+  "type": "module",
+  "version": "5.8.0",
+  "description": "MemberJunction Integration UI Types - lightweight Angular-safe view model types",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MemberJunction/MJ"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC"
 }