create-koppajs 1.1.0 → 1.2.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/CHANGELOG.md +22 -0
- package/README.md +119 -122
- package/bin/create-koppajs.js +158 -13
- package/package.json +2 -1
- package/template-overlays/router/ARCHITECTURE.md +86 -0
- package/template-overlays/router/CHANGELOG.md +44 -0
- package/template-overlays/router/DEVELOPMENT_RULES.md +57 -0
- package/template-overlays/router/README.md +243 -0
- package/template-overlays/router/ROADMAP.md +34 -0
- package/template-overlays/router/TESTING_STRATEGY.md +67 -0
- package/template-overlays/router/docs/adr/0001-keep-the-starter-minimal.md +32 -0
- package/template-overlays/router/docs/architecture/module-boundaries.md +39 -0
- package/template-overlays/router/docs/meta/maintenance.md +38 -0
- package/template-overlays/router/docs/specs/README.md +19 -0
- package/template-overlays/router/docs/specs/app-bootstrap.md +42 -0
- package/template-overlays/router/docs/specs/router-navigation.md +41 -0
- package/template-overlays/router/index.html +14 -0
- package/template-overlays/router/package.json +74 -0
- package/template-overlays/router/pnpm-lock.yaml +3793 -0
- package/template-overlays/router/src/app-view.kpa +128 -0
- package/template-overlays/router/src/home-page.kpa +100 -0
- package/template-overlays/router/src/main.ts +89 -0
- package/template-overlays/router/src/not-found-page.kpa +69 -0
- package/template-overlays/router/src/router-page.kpa +102 -0
- package/template-overlays/router/src/style.css +51 -0
- package/template-overlays/router/tests/e2e/app.spec.ts +38 -0
- package/template-overlays/router/tests/integration/main-bootstrap.test.ts +150 -0
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
2
|
+
|
|
3
|
+
type FakeLink = {
|
|
4
|
+
getAttribute: (name: string) => string | null;
|
|
5
|
+
setAttribute: (name: string, value: string) => void;
|
|
6
|
+
};
|
|
7
|
+
|
|
8
|
+
type RouterCtorOptions = {
|
|
9
|
+
outlet: HTMLElement;
|
|
10
|
+
root: Document;
|
|
11
|
+
routes: Array<{
|
|
12
|
+
path: string;
|
|
13
|
+
componentTag: string;
|
|
14
|
+
}>;
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
const outlet = {} as HTMLElement;
|
|
18
|
+
|
|
19
|
+
function createFakeLink(initialRoute: string, initialHref: string): FakeLink {
|
|
20
|
+
const attributes = new Map([
|
|
21
|
+
["data-route", initialRoute],
|
|
22
|
+
["href", initialHref],
|
|
23
|
+
]);
|
|
24
|
+
|
|
25
|
+
return {
|
|
26
|
+
getAttribute(name: string) {
|
|
27
|
+
return attributes.get(name) ?? null;
|
|
28
|
+
},
|
|
29
|
+
setAttribute(name: string, value: string) {
|
|
30
|
+
attributes.set(name, value);
|
|
31
|
+
},
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
const { core, take, routerCtor, routerHrefFor, routerInit } = vi.hoisted(() => {
|
|
36
|
+
const take = vi.fn();
|
|
37
|
+
const core = Object.assign(vi.fn(), { take });
|
|
38
|
+
const routerInit = vi.fn();
|
|
39
|
+
const routerHrefFor = vi.fn((target: string) => target);
|
|
40
|
+
const routerCtor = vi.fn(function RouterCtor(options: RouterCtorOptions) {
|
|
41
|
+
void options;
|
|
42
|
+
|
|
43
|
+
return {
|
|
44
|
+
hrefFor: routerHrefFor,
|
|
45
|
+
init: routerInit,
|
|
46
|
+
};
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
return {
|
|
50
|
+
core,
|
|
51
|
+
take,
|
|
52
|
+
routerCtor,
|
|
53
|
+
routerHrefFor,
|
|
54
|
+
routerInit,
|
|
55
|
+
};
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
vi.mock("@koppajs/koppajs-core", () => ({
|
|
59
|
+
Core: core,
|
|
60
|
+
}));
|
|
61
|
+
|
|
62
|
+
vi.mock("@koppajs/koppajs-router", () => ({
|
|
63
|
+
KOPPAJS_ROUTE_CHANGE_EVENT: "koppajs-route-change",
|
|
64
|
+
KoppajsRouter: routerCtor,
|
|
65
|
+
}));
|
|
66
|
+
|
|
67
|
+
describe("main bootstrap", () => {
|
|
68
|
+
const querySelector = vi.fn((selector: string) =>
|
|
69
|
+
selector === "#app-outlet" ? outlet : null,
|
|
70
|
+
);
|
|
71
|
+
const querySelectorAll = vi.fn(() => [] as FakeLink[]);
|
|
72
|
+
const addEventListener = vi.fn();
|
|
73
|
+
const requestAnimationFrame = vi.fn();
|
|
74
|
+
let links: FakeLink[] = [];
|
|
75
|
+
|
|
76
|
+
beforeEach(() => {
|
|
77
|
+
links = [createFakeLink("/", "/"), createFakeLink("/router", "/router")];
|
|
78
|
+
|
|
79
|
+
querySelector.mockImplementation((selector: string) =>
|
|
80
|
+
selector === "#app-outlet" ? outlet : null,
|
|
81
|
+
);
|
|
82
|
+
querySelectorAll.mockImplementation(() => links);
|
|
83
|
+
addEventListener.mockReset();
|
|
84
|
+
requestAnimationFrame.mockReset();
|
|
85
|
+
|
|
86
|
+
vi.stubGlobal("document", {
|
|
87
|
+
querySelector,
|
|
88
|
+
querySelectorAll,
|
|
89
|
+
} as unknown as Document);
|
|
90
|
+
vi.stubGlobal("window", {
|
|
91
|
+
addEventListener,
|
|
92
|
+
requestAnimationFrame,
|
|
93
|
+
} as unknown as Window);
|
|
94
|
+
});
|
|
95
|
+
|
|
96
|
+
afterEach(() => {
|
|
97
|
+
core.mockClear();
|
|
98
|
+
take.mockClear();
|
|
99
|
+
routerCtor.mockClear();
|
|
100
|
+
routerHrefFor.mockClear();
|
|
101
|
+
routerInit.mockClear();
|
|
102
|
+
vi.resetModules();
|
|
103
|
+
vi.unstubAllGlobals();
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
it("registers app components, boots core, and starts the router once", async () => {
|
|
107
|
+
await import("../../src/main");
|
|
108
|
+
|
|
109
|
+
expect(take).toHaveBeenCalledTimes(5);
|
|
110
|
+
expect(take).toHaveBeenNthCalledWith(1, expect.anything(), "app-view");
|
|
111
|
+
expect(take).toHaveBeenNthCalledWith(
|
|
112
|
+
2,
|
|
113
|
+
expect.anything(),
|
|
114
|
+
"counter-component",
|
|
115
|
+
);
|
|
116
|
+
expect(take).toHaveBeenNthCalledWith(3, expect.anything(), "home-page");
|
|
117
|
+
expect(take).toHaveBeenNthCalledWith(4, expect.anything(), "router-page");
|
|
118
|
+
expect(take).toHaveBeenNthCalledWith(
|
|
119
|
+
5,
|
|
120
|
+
expect.anything(),
|
|
121
|
+
"not-found-page",
|
|
122
|
+
);
|
|
123
|
+
expect(core).toHaveBeenCalledTimes(1);
|
|
124
|
+
|
|
125
|
+
expect(routerCtor).toHaveBeenCalledTimes(1);
|
|
126
|
+
const [routerOptions] = routerCtor.mock.calls[0] ?? [];
|
|
127
|
+
|
|
128
|
+
expect(routerOptions).toBeDefined();
|
|
129
|
+
expect(routerOptions?.outlet).toBe(outlet);
|
|
130
|
+
expect(routerOptions?.root).toBe(globalThis.document);
|
|
131
|
+
expect(
|
|
132
|
+
routerOptions?.routes.map((route) => ({
|
|
133
|
+
path: route.path,
|
|
134
|
+
componentTag: route.componentTag,
|
|
135
|
+
})),
|
|
136
|
+
).toEqual(
|
|
137
|
+
expect.arrayContaining([
|
|
138
|
+
{ path: "/", componentTag: "home-page" },
|
|
139
|
+
{ path: "/router", componentTag: "router-page" },
|
|
140
|
+
{ path: "*", componentTag: "not-found-page" },
|
|
141
|
+
]),
|
|
142
|
+
);
|
|
143
|
+
expect(addEventListener).toHaveBeenCalledTimes(1);
|
|
144
|
+
expect(routerInit).toHaveBeenCalledTimes(1);
|
|
145
|
+
expect(routerHrefFor).toHaveBeenNthCalledWith(1, "/");
|
|
146
|
+
expect(routerHrefFor).toHaveBeenNthCalledWith(2, "/router");
|
|
147
|
+
expect(links[0]?.getAttribute("href")).toBe("/");
|
|
148
|
+
expect(links[1]?.getAttribute("href")).toBe("/router");
|
|
149
|
+
});
|
|
150
|
+
});
|