@memberjunction/ng-base-types 5.50.0 → 6.1.0-edge.0

package/LICENSE

@@ -0,0 +1,7 @@
+ISC License
+
+Copyright (c) 2023 MemberJunction
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/dist/public-api.d.ts

@@ -1,3 +1,4 @@
 export * from './types';
 export * from './base-angular-component';
+export * from './record-navigation-adapter';
 //# sourceMappingURL=public-api.d.ts.map

package/dist/public-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public-api.d.ts","sourceRoot":"","sources":["../src/public-api.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"public-api.d.ts","sourceRoot":"","sources":["../src/public-api.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC"}

package/dist/public-api.js

@@ -3,4 +3,5 @@
  */
 export * from './types';
 export * from './base-angular-component';
+export * from './record-navigation-adapter';
 //# sourceMappingURL=public-api.js.map

package/dist/public-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"public-api.js","sourceRoot":"","sources":["../src/public-api.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,0BAA0B,CAAC","sourcesContent":["/*\n * Public API Surface\n */\n\nexport * from './types';\nexport * from './base-angular-component';"]}
+{"version":3,"file":"public-api.js","sourceRoot":"","sources":["../src/public-api.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC","sourcesContent":["/*\n * Public API Surface\n */\n\nexport * from './types';\nexport * from './base-angular-component';\nexport * from './record-navigation-adapter';"]}

package/dist/record-navigation-adapter.d.ts

@@ -0,0 +1,64 @@
+import { CompositeKey } from '@memberjunction/core';
+/**
+ * How a widget asks its host to open a record.
+ *
+ * ## Why an adapter rather than an import
+ *
+ * A reusable widget sometimes needs an action only the HOST can perform — opening a record is the
+ * canonical one. Importing `SharedService` or `NavigationService` to do it makes the widget an MJ
+ * Explorer component: it can no longer be mounted in a standalone Angular app, a React host, or a
+ * test. See `guides/UI_LAYERING_GUIDE.md` §3.
+ *
+ * Two ways out, and both are legitimate:
+ *
+ *   1. **An `@Output()` event** — the default. Best when the widget has a direct template host that
+ *      can bind it.
+ *   2. **This adapter** — for widgets mounted DYNAMICALLY through several layers of internal
+ *      wrappers, where threading an output through every layer would be more coupling, not less.
+ *
+ * This mirrors the adapter pattern `@memberjunction/conversations-runtime` already uses for
+ * notifications, active-task tracking and sessions: the runtime declares the interface, the host
+ * registers an implementation once at bootstrap.
+ *
+ * ## Registration
+ *
+ * MJ Explorer registers automatically (`SharedService` does it on construction). A non-Explorer
+ * host registers its own:
+ *
+ * ```typescript
+ * RecordNavigationAdapter.Register({
+ *     OpenEntityRecord: (entityName, key) => myRouter.go(`/records/${entityName}/${key.ToURLSegment()}`),
+ * });
+ * ```
+ *
+ * ## The default is loud on purpose
+ *
+ * With no adapter registered, `OpenEntityRecord` logs an error rather than silently doing nothing.
+ * A drill-through that quietly stops working is the failure mode this whole layering effort exists
+ * to prevent — so a host that forgets to register finds out.
+ */
+export interface IRecordNavigationAdapter {
+    /** Open the given record on whatever surface the host considers appropriate. */
+    OpenEntityRecord(entityName: string, recordKey: CompositeKey): void;
+}
+/**
+ * Host-facing registration point for {@link IRecordNavigationAdapter}.
+ *
+ * Deliberately a plain module-level registry rather than an Angular DI token: widgets that use it
+ * are often created dynamically outside an injector context, which is the situation that made a
+ * simple `@Output()` insufficient in the first place.
+ */
+export declare class RecordNavigationAdapter {
+    /** Register the host's implementation. The last registration wins. */
+    static Register(adapter: IRecordNavigationAdapter): void;
+    /** Whether a host has registered. Lets a widget hide an affordance it cannot fulfil. */
+    static get IsRegistered(): boolean;
+    /**
+     * Ask the host to open a record. Logs an error when no host has registered — never throws,
+     * because a missing drill-through must not take down the surface that offered it.
+     */
+    static OpenEntityRecord(entityName: string, recordKey: CompositeKey): void;
+    /** Clear the registration. Test-support only. */
+    static Reset(): void;
+}
+//# sourceMappingURL=record-navigation-adapter.d.ts.map

package/dist/record-navigation-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-navigation-adapter.d.ts","sourceRoot":"","sources":["../src/record-navigation-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,WAAW,wBAAwB;IACrC,gFAAgF;IAChF,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,GAAG,IAAI,CAAC;CACvE;AAKD;;;;;;GAMG;AACH,qBAAa,uBAAuB;IAChC,sEAAsE;WACxD,QAAQ,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI;IAI/D,wFAAwF;IACxF,WAAkB,YAAY,IAAI,OAAO,CAExC;IAED;;;OAGG;WACW,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,GAAG,IAAI;IAejF,iDAAiD;WACnC,KAAK,IAAI,IAAI;CAG9B"}

package/dist/record-navigation-adapter.js

@@ -0,0 +1,42 @@
+import { LogError } from '@memberjunction/core';
+/** The registered adapter, or null before any host registers one. */
+let registered = null;
+/**
+ * Host-facing registration point for {@link IRecordNavigationAdapter}.
+ *
+ * Deliberately a plain module-level registry rather than an Angular DI token: widgets that use it
+ * are often created dynamically outside an injector context, which is the situation that made a
+ * simple `@Output()` insufficient in the first place.
+ */
+export class RecordNavigationAdapter {
+    /** Register the host's implementation. The last registration wins. */
+    static Register(adapter) {
+        registered = adapter;
+    }
+    /** Whether a host has registered. Lets a widget hide an affordance it cannot fulfil. */
+    static get IsRegistered() {
+        return registered !== null;
+    }
+    /**
+     * Ask the host to open a record. Logs an error when no host has registered — never throws,
+     * because a missing drill-through must not take down the surface that offered it.
+     */
+    static OpenEntityRecord(entityName, recordKey) {
+        if (!registered) {
+            LogError(`RecordNavigationAdapter: no host registered, so "${entityName}" could not be opened. ` +
+                `The host application must call RecordNavigationAdapter.Register(...) at bootstrap.`);
+            return;
+        }
+        try {
+            registered.OpenEntityRecord(entityName, recordKey);
+        }
+        catch (e) {
+            LogError(`RecordNavigationAdapter.OpenEntityRecord failed: ${e instanceof Error ? e.message : String(e)}`);
+        }
+    }
+    /** Clear the registration. Test-support only. */
+    static Reset() {
+        registered = null;
+    }
+}
+//# sourceMappingURL=record-navigation-adapter.js.map

package/dist/record-navigation-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-navigation-adapter.js","sourceRoot":"","sources":["../src/record-navigation-adapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AA6ChD,qEAAqE;AACrE,IAAI,UAAU,GAAoC,IAAI,CAAC;AAEvD;;;;;;GAMG;AACH,MAAM,OAAO,uBAAuB;IAChC,sEAAsE;IAC/D,MAAM,CAAC,QAAQ,CAAC,OAAiC;QACpD,UAAU,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,wFAAwF;IACjF,MAAM,KAAK,YAAY;QAC1B,OAAO,UAAU,KAAK,IAAI,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,gBAAgB,CAAC,UAAkB,EAAE,SAAuB;QACtE,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,QAAQ,CACJ,oDAAoD,UAAU,yBAAyB;gBACvF,oFAAoF,CACvF,CAAC;YACF,OAAO;QACX,CAAC;QACD,IAAI,CAAC;YACD,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACvD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,QAAQ,CAAC,oDAAoD,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/G,CAAC;IACL,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,KAAK;QACf,UAAU,GAAG,IAAI,CAAC;IACtB,CAAC;CACJ","sourcesContent":["import { CompositeKey } from '@memberjunction/core';\nimport { LogError } from '@memberjunction/core';\n\n/**\n * How a widget asks its host to open a record.\n *\n * ## Why an adapter rather than an import\n *\n * A reusable widget sometimes needs an action only the HOST can perform — opening a record is the\n * canonical one. Importing `SharedService` or `NavigationService` to do it makes the widget an MJ\n * Explorer component: it can no longer be mounted in a standalone Angular app, a React host, or a\n * test. See `guides/UI_LAYERING_GUIDE.md` §3.\n *\n * Two ways out, and both are legitimate:\n *\n *   1. **An `@Output()` event** — the default. Best when the widget has a direct template host that\n *      can bind it.\n *   2. **This adapter** — for widgets mounted DYNAMICALLY through several layers of internal\n *      wrappers, where threading an output through every layer would be more coupling, not less.\n *\n * This mirrors the adapter pattern `@memberjunction/conversations-runtime` already uses for\n * notifications, active-task tracking and sessions: the runtime declares the interface, the host\n * registers an implementation once at bootstrap.\n *\n * ## Registration\n *\n * MJ Explorer registers automatically (`SharedService` does it on construction). A non-Explorer\n * host registers its own:\n *\n * ```typescript\n * RecordNavigationAdapter.Register({\n *     OpenEntityRecord: (entityName, key) => myRouter.go(`/records/${entityName}/${key.ToURLSegment()}`),\n * });\n * ```\n *\n * ## The default is loud on purpose\n *\n * With no adapter registered, `OpenEntityRecord` logs an error rather than silently doing nothing.\n * A drill-through that quietly stops working is the failure mode this whole layering effort exists\n * to prevent — so a host that forgets to register finds out.\n */\nexport interface IRecordNavigationAdapter {\n    /** Open the given record on whatever surface the host considers appropriate. */\n    OpenEntityRecord(entityName: string, recordKey: CompositeKey): void;\n}\n\n/** The registered adapter, or null before any host registers one. */\nlet registered: IRecordNavigationAdapter | null = null;\n\n/**\n * Host-facing registration point for {@link IRecordNavigationAdapter}.\n *\n * Deliberately a plain module-level registry rather than an Angular DI token: widgets that use it\n * are often created dynamically outside an injector context, which is the situation that made a\n * simple `@Output()` insufficient in the first place.\n */\nexport class RecordNavigationAdapter {\n    /** Register the host's implementation. The last registration wins. */\n    public static Register(adapter: IRecordNavigationAdapter): void {\n        registered = adapter;\n    }\n\n    /** Whether a host has registered. Lets a widget hide an affordance it cannot fulfil. */\n    public static get IsRegistered(): boolean {\n        return registered !== null;\n    }\n\n    /**\n     * Ask the host to open a record. Logs an error when no host has registered — never throws,\n     * because a missing drill-through must not take down the surface that offered it.\n     */\n    public static OpenEntityRecord(entityName: string, recordKey: CompositeKey): void {\n        if (!registered) {\n            LogError(\n                `RecordNavigationAdapter: no host registered, so \"${entityName}\" could not be opened. ` +\n                `The host application must call RecordNavigationAdapter.Register(...) at bootstrap.`,\n            );\n            return;\n        }\n        try {\n            registered.OpenEntityRecord(entityName, recordKey);\n        } catch (e) {\n            LogError(`RecordNavigationAdapter.OpenEntityRecord failed: ${e instanceof Error ? e.message : String(e)}`);\n        }\n    }\n\n    /** Clear the registration. Test-support only. */\n    public static Reset(): void {\n        registered = null;\n    }\n}\n"]}

package/package.json

@@ -1,17 +1,12 @@
 {
   "name": "@memberjunction/ng-base-types",
-  "version": "5.50.0",
+  "version": "6.1.0-edge.0",
   "description": "MemberJunction: Simple types that are used across many generic Angular UI components for coordination",
   "main": "./dist/public-api.js",
   "typings": "./dist/public-api.d.ts",
   "files": [
     "/dist"
   ],
-  "scripts": {
-    "test": "vitest run",
-    "build": "ngc",
-    "test:watch": "vitest"
-  },
   "keywords": [],
   "author": "",
   "license": "ISC",
@@ -25,14 +20,20 @@
     "@angular/core": "21.1.3"
   },
   "dependencies": {
-    "@memberjunction/core-entities": "5.50.0",
-    "@memberjunction/global": "5.50.0",
-    "@memberjunction/core": "5.50.0",
+    "@memberjunction/core-entities": "6.1.0-edge.0",
+    "@memberjunction/global": "6.1.0-edge.0",
+    "@memberjunction/core": "6.1.0-edge.0",
     "tslib": "^2.8.1"
   },
   "sideEffects": false,
   "repository": {
     "type": "git",
     "url": "https://github.com/MemberJunction/MJ"
+  },
+  "mjUILayer": "widgets",
+  "scripts": {
+    "test": "vitest run",
+    "build": "ngc",
+    "test:watch": "vitest"
   }
-}
+}