@memberjunction/integration-ui-types 0.0.1 → 5.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,45 +1,25 @@
1
1
  # @memberjunction/integration-ui-types
2
2
 
3
- ## ⚠️ IMPORTANT NOTICE ⚠️
3
+ Lightweight, Angular-safe view model types for the MemberJunction Integration UI.
4
4
 
5
- **This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
5
+ 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.
6
6
 
7
- This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
7
+ ## Types
8
8
 
9
- ## Purpose
9
+ | Type | Description |
10
+ |------|-------------|
11
+ | `IntegrationSummary` | Overview of a company integration's current state |
12
+ | `ConnectorHealth` | Health status union: `'Healthy' \| 'Degraded' \| 'Offline' \| 'Unknown'` |
13
+ | `RunStatusSummary` | Summary of a single integration run |
14
+ | `EntityMapSummary` | Entity map sync configuration summary |
15
+ | `IntegrationDashboardStats` | Aggregate stats for dashboard overview |
10
16
 
11
- This package exists to:
12
- 1. Configure OIDC trusted publishing for the package name `@memberjunction/integration-ui-types`
13
- 2. Enable secure, token-less publishing from CI/CD workflows
14
- 3. Establish provenance for packages published under this name
17
+ ## Usage
15
18
 
16
- ## What is OIDC Trusted Publishing?
17
-
18
- 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.
19
-
20
- ## Setup Instructions
21
-
22
- To properly configure OIDC trusted publishing for this package:
23
-
24
- 1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
25
- 2. Configure the trusted publisher (e.g., GitHub Actions)
26
- 3. Specify the repository and workflow that should be allowed to publish
27
- 4. Use the configured workflow to publish your actual package
28
-
29
- ## DO NOT USE THIS PACKAGE
30
-
31
- This package is a placeholder for OIDC configuration only. It:
32
- - Contains no executable code
33
- - Provides no functionality
34
- - Should not be installed as a dependency
35
- - Exists only for administrative purposes
36
-
37
- ## More Information
38
-
39
- For more details about npm's trusted publishing feature, see:
40
- - [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
41
- - [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
42
-
43
- ---
44
-
45
- **Maintained for OIDC setup purposes only**
19
+ ```typescript
20
+ import type {
21
+ IntegrationSummary,
22
+ RunStatusSummary,
23
+ ConnectorHealth,
24
+ } from '@memberjunction/integration-ui-types';
25
+ ```
@@ -0,0 +1,75 @@
1
+ /** Summary of an integration's current state for UI display */
2
+ export interface IntegrationSummary {
3
+ /** Company Integration ID */
4
+ CompanyIntegrationID: string;
5
+ /** Display name of the integration (e.g., "HubSpot", "Salesforce") */
6
+ IntegrationName: string;
7
+ /** Company name */
8
+ CompanyName: string;
9
+ /** Whether the integration is currently active */
10
+ IsActive: boolean;
11
+ /** Number of active entity maps configured */
12
+ EntityMapCount: number;
13
+ /** Timestamp of the last successful sync */
14
+ LastSyncAt: string | null;
15
+ /** Current connector health status */
16
+ Health: ConnectorHealth;
17
+ }
18
+ /** Health status of a connector */
19
+ export type ConnectorHealth = 'Healthy' | 'Degraded' | 'Offline' | 'Unknown';
20
+ /** Summary of a single integration run for UI display */
21
+ export interface RunStatusSummary {
22
+ /** Run ID */
23
+ RunID: string;
24
+ /** Company Integration ID */
25
+ CompanyIntegrationID: string;
26
+ /** Integration display name */
27
+ IntegrationName: string;
28
+ /** Current run status */
29
+ Status: 'Pending' | 'In Progress' | 'Success' | 'Failed';
30
+ /** Who triggered the run */
31
+ RunByUser: string;
32
+ /** When the run started */
33
+ StartedAt: string;
34
+ /** When the run ended (null if still running) */
35
+ EndedAt: string | null;
36
+ /** Total records processed */
37
+ TotalRecords: number;
38
+ /** Records created */
39
+ RecordsCreated: number;
40
+ /** Records updated */
41
+ RecordsUpdated: number;
42
+ /** Records that had errors */
43
+ RecordsErrored: number;
44
+ /** Duration in seconds (computed on the client from StartedAt/EndedAt) */
45
+ DurationSeconds: number | null;
46
+ }
47
+ /** Summary of an entity map's sync configuration for UI display */
48
+ export interface EntityMapSummary {
49
+ /** Entity Map ID */
50
+ EntityMapID: string;
51
+ /** External object name (e.g., "Contact") */
52
+ ExternalObjectName: string;
53
+ /** MJ Entity name */
54
+ MJEntityName: string;
55
+ /** Sync direction */
56
+ SyncDirection: 'Pull' | 'Push' | 'Bidirectional';
57
+ /** Whether sync is enabled */
58
+ SyncEnabled: boolean;
59
+ /** Number of active field maps */
60
+ FieldMapCount: number;
61
+ /** Last watermark value */
62
+ LastWatermarkValue: string | null;
63
+ }
64
+ /** Stats for the integration dashboard overview */
65
+ export interface IntegrationDashboardStats {
66
+ /** Total number of active integrations */
67
+ ActiveIntegrations: number;
68
+ /** Total records synced across all integrations today */
69
+ RecordsSyncedToday: number;
70
+ /** Number of failed runs in the last 24 hours */
71
+ FailedRunsLast24h: number;
72
+ /** Next scheduled sync time */
73
+ NextScheduledSync: string | null;
74
+ }
75
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
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 ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,10 +1,23 @@
1
1
  {
2
2
  "name": "@memberjunction/integration-ui-types",
3
- "version": "0.0.1",
4
- "description": "OIDC trusted publishing setup package for @memberjunction/integration-ui-types",
5
- "keywords": [
6
- "oidc",
7
- "trusted-publishing",
8
- "setup"
9
- ]
3
+ "type": "module",
4
+ "version": "5.9.0",
5
+ "description": "MemberJunction Integration UI Types - lightweight Angular-safe view model types",
6
+ "main": "dist/index.js",
7
+ "types": "dist/index.d.ts",
8
+ "files": [
9
+ "/dist"
10
+ ],
11
+ "scripts": {
12
+ "build": "tsc -p tsconfig.json"
13
+ },
14
+ "devDependencies": {
15
+ "typescript": "^5.9.3"
16
+ },
17
+ "repository": {
18
+ "type": "git",
19
+ "url": "https://github.com/MemberJunction/MJ"
20
+ },
21
+ "author": "MemberJunction.com",
22
+ "license": "ISC"
10
23
  }