@agorapulse/ui-components 22.9.3-beta.1 → 22.9.5-beta.1

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.
@@ -0,0 +1,78 @@
1
+ import { SnackbarsThreadService } from '@agorapulse/ui-components/snackbars-thread';
2
+ import * as i0 from '@angular/core';
3
+ import { Injectable } from '@angular/core';
4
+
5
+ const DEFAULT_TIMEOUT = 5000;
6
+ const TYPE_OF_INDEX = {
7
+ 0: 'info',
8
+ 1: 'success',
9
+ 2: 'warning',
10
+ 3: 'error',
11
+ };
12
+ function shownText(request) {
13
+ if (typeof request === 'string') {
14
+ return { key: request };
15
+ }
16
+ if ('raw' in request) {
17
+ return { raw: request.raw };
18
+ }
19
+ return request.params === undefined ? { key: request.key } : { key: request.key, params: request.params };
20
+ }
21
+ /**
22
+ * A {@link SnackbarsThreadService} for specs: it records every snackbar in {@link shown}, with its tone and its texts,
23
+ * and never starts a timer. It needs no test runner, so it works under Jest and Vitest alike.
24
+ *
25
+ * @example
26
+ * TestBed.configureTestingModule({ providers: [provideFakeSnackbars()] });
27
+ * const snackbars = TestBed.inject(FakeSnackbarsThreadService);
28
+ * // ...act...
29
+ * expect(snackbars.shown).toEqual([{ type: 'error', message: { key: 'post.failed' } }]);
30
+ */
31
+ class FakeSnackbarsThreadService extends SnackbarsThreadService {
32
+ /** Every snackbar shown, oldest first; removing one does not drop it from here. */
33
+ shown = [];
34
+ pendingType;
35
+ show(message, type, timeout) {
36
+ this.pendingType = type;
37
+ return super.show(message, type, timeout);
38
+ }
39
+ addWithId(elem, id, timeout = DEFAULT_TIMEOUT) {
40
+ const type = this.pendingType ?? TYPE_OF_INDEX[elem.snackbarType];
41
+ this.pendingType = undefined;
42
+ this.shown.push({
43
+ type,
44
+ message: shownText(elem.i18n.message),
45
+ ...(elem.i18n.action === undefined ? {} : { action: shownText(elem.i18n.action) }),
46
+ ...(elem.navigateInternalUrl === undefined ? {} : { navigateInternalUrl: elem.navigateInternalUrl }),
47
+ ...(elem.openUrlInNewTab === undefined ? {} : { openUrlInNewTab: elem.openUrlInNewTab }),
48
+ ...(elem.callback === undefined ? {} : { callback: elem.callback }),
49
+ ...(timeout === DEFAULT_TIMEOUT ? {} : { timeout }),
50
+ });
51
+ super.addWithId(elem, id, 0);
52
+ }
53
+ /** Forgets every snackbar shown so far, e.g. the ones a spec's setup raised. */
54
+ clear() {
55
+ this.shown.length = 0;
56
+ }
57
+ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.0.5", ngImport: i0, type: FakeSnackbarsThreadService, deps: null, target: i0.ɵɵFactoryTarget.Injectable });
58
+ static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "22.0.5", ngImport: i0, type: FakeSnackbarsThreadService });
59
+ }
60
+ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.0.5", ngImport: i0, type: FakeSnackbarsThreadService, decorators: [{
61
+ type: Injectable
62
+ }] });
63
+ /**
64
+ * Provides {@link FakeSnackbarsThreadService} in place of {@link SnackbarsThreadService}; inject the fake to read what was shown.
65
+ *
66
+ * @example
67
+ * providers: [provideFakeSnackbars()]
68
+ */
69
+ function provideFakeSnackbars() {
70
+ return [FakeSnackbarsThreadService, { provide: SnackbarsThreadService, useExisting: FakeSnackbarsThreadService }];
71
+ }
72
+
73
+ /**
74
+ * Generated bundle index. Do not edit.
75
+ */
76
+
77
+ export { FakeSnackbarsThreadService, provideFakeSnackbars };
78
+ //# sourceMappingURL=agorapulse-ui-components-testing.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"agorapulse-ui-components-testing.mjs","sources":["../../../libs/ui-components/testing/src/fake-snackbars-thread.service.ts","../../../libs/ui-components/testing/src/agorapulse-ui-components-testing.ts"],"sourcesContent":["import { TranslationRequest } from '@agorapulse/ui-components/i18n';\nimport { externalSnackbarTypeAllowed, SnackbarsThreadBase, SnackbarsThreadService } from '@agorapulse/ui-components/snackbars-thread';\nimport { Injectable, Provider } from '@angular/core';\n\n/** A text as a spec compares it: a key with its optional params, or raw text. A bare key string becomes `{ key }`. */\nexport type ShownText = { key: string; params?: Record<string, unknown> } | { raw: string };\n\n/** One snackbar the code under test showed. */\nexport interface ShownSnackbar {\n type: externalSnackbarTypeAllowed;\n message: ShownText;\n action?: ShownText;\n navigateInternalUrl?: string;\n openUrlInNewTab?: boolean;\n callback?: () => void;\n /** Present only when it differs from the service's default of 5000 ms; 0 keeps the snackbar open. */\n timeout?: number;\n}\n\nconst DEFAULT_TIMEOUT = 5000;\n\nconst TYPE_OF_INDEX: Record<SnackbarsThreadBase['snackbarType'], externalSnackbarTypeAllowed> = {\n 0: 'info',\n 1: 'success',\n 2: 'warning',\n 3: 'error',\n};\n\nfunction shownText(request: TranslationRequest): ShownText {\n if (typeof request === 'string') {\n return { key: request };\n }\n if ('raw' in request) {\n return { raw: request.raw };\n }\n return request.params === undefined ? { key: request.key } : { key: request.key, params: request.params };\n}\n\n/**\n * A {@link SnackbarsThreadService} for specs: it records every snackbar in {@link shown}, with its tone and its texts,\n * and never starts a timer. It needs no test runner, so it works under Jest and Vitest alike.\n *\n * @example\n * TestBed.configureTestingModule({ providers: [provideFakeSnackbars()] });\n * const snackbars = TestBed.inject(FakeSnackbarsThreadService);\n * // ...act...\n * expect(snackbars.shown).toEqual([{ type: 'error', message: { key: 'post.failed' } }]);\n */\n@Injectable()\nexport class FakeSnackbarsThreadService extends SnackbarsThreadService {\n /** Every snackbar shown, oldest first; removing one does not drop it from here. */\n readonly shown: ShownSnackbar[] = [];\n\n private pendingType: externalSnackbarTypeAllowed | undefined;\n\n override show(message: TranslationRequest, type: externalSnackbarTypeAllowed, timeout?: number): string {\n this.pendingType = type;\n return super.show(message, type, timeout);\n }\n\n override addWithId(elem: SnackbarsThreadBase, id: string, timeout: number = DEFAULT_TIMEOUT): void {\n const type = this.pendingType ?? TYPE_OF_INDEX[elem.snackbarType];\n this.pendingType = undefined;\n this.shown.push({\n type,\n message: shownText(elem.i18n.message),\n ...(elem.i18n.action === undefined ? {} : { action: shownText(elem.i18n.action) }),\n ...(elem.navigateInternalUrl === undefined ? {} : { navigateInternalUrl: elem.navigateInternalUrl }),\n ...(elem.openUrlInNewTab === undefined ? {} : { openUrlInNewTab: elem.openUrlInNewTab }),\n ...(elem.callback === undefined ? {} : { callback: elem.callback }),\n ...(timeout === DEFAULT_TIMEOUT ? {} : { timeout }),\n });\n super.addWithId(elem, id, 0);\n }\n\n /** Forgets every snackbar shown so far, e.g. the ones a spec's setup raised. */\n clear(): void {\n this.shown.length = 0;\n }\n}\n\n/**\n * Provides {@link FakeSnackbarsThreadService} in place of {@link SnackbarsThreadService}; inject the fake to read what was shown.\n *\n * @example\n * providers: [provideFakeSnackbars()]\n */\nexport function provideFakeSnackbars(): Provider[] {\n return [FakeSnackbarsThreadService, { provide: SnackbarsThreadService, useExisting: FakeSnackbarsThreadService }];\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public_api';\n"],"names":[],"mappings":";;;;AAmBA,MAAM,eAAe,GAAG,IAAI;AAE5B,MAAM,aAAa,GAA6E;AAC5F,IAAA,CAAC,EAAE,MAAM;AACT,IAAA,CAAC,EAAE,SAAS;AACZ,IAAA,CAAC,EAAE,SAAS;AACZ,IAAA,CAAC,EAAE,OAAO;CACb;AAED,SAAS,SAAS,CAAC,OAA2B,EAAA;AAC1C,IAAA,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;AAC7B,QAAA,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE;IAC3B;AACA,IAAA,IAAI,KAAK,IAAI,OAAO,EAAE;AAClB,QAAA,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;IAC/B;AACA,IAAA,OAAO,OAAO,CAAC,MAAM,KAAK,SAAS,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE;AAC7G;AAEA;;;;;;;;;AASG;AAEG,MAAO,0BAA2B,SAAQ,sBAAsB,CAAA;;IAEzD,KAAK,GAAoB,EAAE;AAE5B,IAAA,WAAW;AAEV,IAAA,IAAI,CAAC,OAA2B,EAAE,IAAiC,EAAE,OAAgB,EAAA;AAC1F,QAAA,IAAI,CAAC,WAAW,GAAG,IAAI;QACvB,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC;IAC7C;AAES,IAAA,SAAS,CAAC,IAAyB,EAAE,EAAU,EAAE,UAAkB,eAAe,EAAA;AACvF,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,IAAI,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC;AACjE,QAAA,IAAI,CAAC,WAAW,GAAG,SAAS;AAC5B,QAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YACZ,IAAI;YACJ,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACrC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAClF,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,GAAG,EAAE,GAAG,EAAE,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACpG,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;YACxF,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;AACnE,YAAA,IAAI,OAAO,KAAK,eAAe,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;AACtD,SAAA,CAAC;QACF,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAChC;;IAGA,KAAK,GAAA;AACD,QAAA,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;IACzB;uGA7BS,0BAA0B,EAAA,IAAA,EAAA,IAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;2GAA1B,0BAA0B,EAAA,CAAA;;2FAA1B,0BAA0B,EAAA,UAAA,EAAA,CAAA;kBADtC;;AAiCD;;;;;AAKG;SACa,oBAAoB,GAAA;AAChC,IAAA,OAAO,CAAC,0BAA0B,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,WAAW,EAAE,0BAA0B,EAAE,CAAC;AACrH;;ACzFA;;AAEG;;;;"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@agorapulse/ui-components",
3
3
  "description": "Agorapulse UI Components Library",
4
- "version": "22.9.3-beta.1",
4
+ "version": "22.9.5-beta.1",
5
5
  "author": "Benoit Hediard",
6
6
  "repository": {
7
7
  "type": "git",
@@ -281,6 +281,10 @@
281
281
  "types": "./types/agorapulse-ui-components-tag.d.ts",
282
282
  "default": "./fesm2022/agorapulse-ui-components-tag.mjs"
283
283
  },
284
+ "./testing": {
285
+ "types": "./types/agorapulse-ui-components-testing.d.ts",
286
+ "default": "./fesm2022/agorapulse-ui-components-testing.mjs"
287
+ },
284
288
  "./text-measurement": {
285
289
  "types": "./types/agorapulse-ui-components-text-measurement.d.ts",
286
290
  "default": "./fesm2022/agorapulse-ui-components-text-measurement.mjs"
@@ -0,0 +1,54 @@
1
+ import { TranslationRequest } from '@agorapulse/ui-components/i18n';
2
+ import { SnackbarsThreadService, externalSnackbarTypeAllowed, SnackbarsThreadBase } from '@agorapulse/ui-components/snackbars-thread';
3
+ import * as i0 from '@angular/core';
4
+ import { Provider } from '@angular/core';
5
+
6
+ /** A text as a spec compares it: a key with its optional params, or raw text. A bare key string becomes `{ key }`. */
7
+ type ShownText = {
8
+ key: string;
9
+ params?: Record<string, unknown>;
10
+ } | {
11
+ raw: string;
12
+ };
13
+ /** One snackbar the code under test showed. */
14
+ interface ShownSnackbar {
15
+ type: externalSnackbarTypeAllowed;
16
+ message: ShownText;
17
+ action?: ShownText;
18
+ navigateInternalUrl?: string;
19
+ openUrlInNewTab?: boolean;
20
+ callback?: () => void;
21
+ /** Present only when it differs from the service's default of 5000 ms; 0 keeps the snackbar open. */
22
+ timeout?: number;
23
+ }
24
+ /**
25
+ * A {@link SnackbarsThreadService} for specs: it records every snackbar in {@link shown}, with its tone and its texts,
26
+ * and never starts a timer. It needs no test runner, so it works under Jest and Vitest alike.
27
+ *
28
+ * @example
29
+ * TestBed.configureTestingModule({ providers: [provideFakeSnackbars()] });
30
+ * const snackbars = TestBed.inject(FakeSnackbarsThreadService);
31
+ * // ...act...
32
+ * expect(snackbars.shown).toEqual([{ type: 'error', message: { key: 'post.failed' } }]);
33
+ */
34
+ declare class FakeSnackbarsThreadService extends SnackbarsThreadService {
35
+ /** Every snackbar shown, oldest first; removing one does not drop it from here. */
36
+ readonly shown: ShownSnackbar[];
37
+ private pendingType;
38
+ show(message: TranslationRequest, type: externalSnackbarTypeAllowed, timeout?: number): string;
39
+ addWithId(elem: SnackbarsThreadBase, id: string, timeout?: number): void;
40
+ /** Forgets every snackbar shown so far, e.g. the ones a spec's setup raised. */
41
+ clear(): void;
42
+ static ɵfac: i0.ɵɵFactoryDeclaration<FakeSnackbarsThreadService, never>;
43
+ static ɵprov: i0.ɵɵInjectableDeclaration<FakeSnackbarsThreadService>;
44
+ }
45
+ /**
46
+ * Provides {@link FakeSnackbarsThreadService} in place of {@link SnackbarsThreadService}; inject the fake to read what was shown.
47
+ *
48
+ * @example
49
+ * providers: [provideFakeSnackbars()]
50
+ */
51
+ declare function provideFakeSnackbars(): Provider[];
52
+
53
+ export { FakeSnackbarsThreadService, provideFakeSnackbars };
54
+ export type { ShownSnackbar, ShownText };