dbtour-addon-explorer 0.2.0 → 0.2.4

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.
Files changed (8) hide show
  1. package/dist/index.d.ts +4 -0
  2. package/dist/index.js +43 -0
  3. package/dist/mark.d.ts +13 -0
  4. package/dist/mark.js +19 -0
  5. package/fonts/OFL-Archivo.txt +93 -0
  6. package/fonts/OFL-RedHatMono.txt +93 -0
  7. package/package.json +11 -7
  8. package/src/index.ts +0 -47
package/dist/index.d.ts ADDED
@@ -0,0 +1,4 @@
1
+ import type { Model } from 'dbtour/model';
2
+ export declare function render(model: Model): Record<string, string>;
3
+ /** The HTML around the bundle and the model. Pure, so it is tested without the build. */
4
+ export declare function pageHtml(model: Model, js: string, css: string): string;
package/dist/index.js ADDED
@@ -0,0 +1,43 @@
1
+ // The explorer add-on: render(model) returns index.html with the page and the model inlined, so the file
2
+ // opens from disk with no server and no network. The page itself is built from src/page into dist/.
3
+ import { readFileSync } from 'node:fs';
4
+ import { markDataUri } from "./mark.js";
5
+ export function render(model) {
6
+ return { 'index.html': pageHtml(model, builtFile('page.js'), builtFile('page.css')) };
7
+ }
8
+ function builtFile(name) {
9
+ try {
10
+ return readFileSync(new URL(`../dist/${name}`, import.meta.url), 'utf8');
11
+ }
12
+ catch (error) {
13
+ throw new Error(`dbtour-addon-explorer has no dist/${name}: in the dbtour repository run npm run build, otherwise reinstall the package`, { cause: error });
14
+ }
15
+ }
16
+ /** The HTML around the bundle and the model. Pure, so it is tested without the build. */
17
+ export function pageHtml(model, js, css) {
18
+ const title = `${model.databases.map((d) => d.name).join(', ') || 'dbtour'} · dbtour`;
19
+ // Inside a JSON string "<" is "<", so no "</script" or "<!--" can end the element early. The bundle
20
+ // gets the same treatment where "</script" could appear inside one of its strings or patterns.
21
+ const json = JSON.stringify(model).replace(/</g, '\\u003c');
22
+ const script = js.replace(/<\/(script)/gi, '<\\/$1');
23
+ return `<!doctype html>
24
+ <html lang="en">
25
+ <head>
26
+ <meta charset="utf-8">
27
+ <meta name="viewport" content="width=device-width, initial-scale=1">
28
+ <meta name="color-scheme" content="light dark">
29
+ <title>${escapeHtml(title)}</title>
30
+ <link rel="icon" href="${markDataUri()}">
31
+ <style>${css}</style>
32
+ </head>
33
+ <body>
34
+ <div id="app"></div>
35
+ <script id="dbtour-model" type="application/json">${json}</script>
36
+ <script>${script}</script>
37
+ </body>
38
+ </html>
39
+ `;
40
+ }
41
+ function escapeHtml(text) {
42
+ return text.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
43
+ }
package/dist/mark.d.ts ADDED
@@ -0,0 +1,13 @@
1
+ /** The cylinder, in a 24-unit box: the top ellipse and the body closed by the bottom arc. */
2
+ export declare const markCylinderTop: {
3
+ cx: number;
4
+ cy: number;
5
+ rx: number;
6
+ ry: number;
7
+ };
8
+ export declare const markCylinderBody = "M3.5,6.5 V17.5 A8.5,3 0 0 0 20.5,17.5 V6.5";
9
+ /** The pulse across the body: a plain column, a key, a foreign key. */
10
+ export declare const markPulse = "3.5,14.5 6.5,14.5 8,11 9.5,14.5 11.5,14.5 13,12 14.5,14.5 16.5,14.5 17.5,13 18.5,14.5 20.5,14.5";
11
+ export declare function markSvg(size: number, ink: string, strokeWidth?: number): string;
12
+ /** For <link rel="icon">: the mark as a data URI, in the ink that reads on both light and dark tabs. */
13
+ export declare function markDataUri(ink?: string): string;
package/dist/mark.js ADDED
@@ -0,0 +1,19 @@
1
+ // The dbtour mark: a database cylinder with a table's pulse running through it, one geometry at every size.
2
+ // Shared by the page (the header), the favicon that index.ts inlines, and the brand files in brand/.
3
+ /** The cylinder, in a 24-unit box: the top ellipse and the body closed by the bottom arc. */
4
+ export const markCylinderTop = { cx: 12, cy: 6.5, rx: 8.5, ry: 3 };
5
+ export const markCylinderBody = 'M3.5,6.5 V17.5 A8.5,3 0 0 0 20.5,17.5 V6.5';
6
+ /** The pulse across the body: a plain column, a key, a foreign key. */
7
+ export const markPulse = '3.5,14.5 6.5,14.5 8,11 9.5,14.5 11.5,14.5 13,12 14.5,14.5 16.5,14.5 17.5,13 18.5,14.5 20.5,14.5';
8
+ export function markSvg(size, ink, strokeWidth = 1.5) {
9
+ const { cx, cy, rx, ry } = markCylinderTop;
10
+ return (`<svg xmlns="http://www.w3.org/2000/svg" width="${size}" height="${size}" viewBox="0 0 24 24" fill="none" stroke="${ink}" stroke-width="${strokeWidth}" stroke-linejoin="miter" stroke-linecap="butt">` +
11
+ `<ellipse cx="${cx}" cy="${cy}" rx="${rx}" ry="${ry}"/>` +
12
+ `<path d="${markCylinderBody}"/>` +
13
+ `<polyline points="${markPulse}"/>` +
14
+ `</svg>`);
15
+ }
16
+ /** For <link rel="icon">: the mark as a data URI, in the ink that reads on both light and dark tabs. */
17
+ export function markDataUri(ink = '#8c8c8c') {
18
+ return `data:image/svg+xml,${encodeURIComponent(markSvg(32, ink, 2))}`;
19
+ }
package/fonts/OFL-Archivo.txt ADDED
@@ -0,0 +1,93 @@
1
+ Copyright 2020 The Archivo Project Authors (https://github.com/Omnibus-Type/Archivo)
2
+
3
+ This Font Software is licensed under the SIL Open Font License, Version 1.1.
4
+ This license is copied below, and is also available with a FAQ at:
5
+ http://scripts.sil.org/OFL
6
+
7
+
8
+ -----------------------------------------------------------
9
+ SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10
+ -----------------------------------------------------------
11
+
12
+ PREAMBLE
13
+ The goals of the Open Font License (OFL) are to stimulate worldwide
14
+ development of collaborative font projects, to support the font creation
15
+ efforts of academic and linguistic communities, and to provide a free and
16
+ open framework in which fonts may be shared and improved in partnership
17
+ with others.
18
+
19
+ The OFL allows the licensed fonts to be used, studied, modified and
20
+ redistributed freely as long as they are not sold by themselves. The
21
+ fonts, including any derivative works, can be bundled, embedded,
22
+ redistributed and/or sold with any software provided that any reserved
23
+ names are not used by derivative works. The fonts and derivatives,
24
+ however, cannot be released under any other type of license. The
25
+ requirement for fonts to remain under this license does not apply
26
+ to any document created using the fonts or their derivatives.
27
+
28
+ DEFINITIONS
29
+ "Font Software" refers to the set of files released by the Copyright
30
+ Holder(s) under this license and clearly marked as such. This may
31
+ include source files, build scripts and documentation.
32
+
33
+ "Reserved Font Name" refers to any names specified as such after the
34
+ copyright statement(s).
35
+
36
+ "Original Version" refers to the collection of Font Software components as
37
+ distributed by the Copyright Holder(s).
38
+
39
+ "Modified Version" refers to any derivative made by adding to, deleting,
40
+ or substituting -- in part or in whole -- any of the components of the
41
+ Original Version, by changing formats or by porting the Font Software to a
42
+ new environment.
43
+
44
+ "Author" refers to any designer, engineer, programmer, technical
45
+ writer or other person who contributed to the Font Software.
46
+
47
+ PERMISSION & CONDITIONS
48
+ Permission is hereby granted, free of charge, to any person obtaining
49
+ a copy of the Font Software, to use, study, copy, merge, embed, modify,
50
+ redistribute, and sell modified and unmodified copies of the Font
51
+ Software, subject to the following conditions:
52
+
53
+ 1) Neither the Font Software nor any of its individual components,
54
+ in Original or Modified Versions, may be sold by itself.
55
+
56
+ 2) Original or Modified Versions of the Font Software may be bundled,
57
+ redistributed and/or sold with any software, provided that each copy
58
+ contains the above copyright notice and this license. These can be
59
+ included either as stand-alone text files, human-readable headers or
60
+ in the appropriate machine-readable metadata fields within text or
61
+ binary files as long as those fields can be easily viewed by the user.
62
+
63
+ 3) No Modified Version of the Font Software may use the Reserved Font
64
+ Name(s) unless explicit written permission is granted by the corresponding
65
+ Copyright Holder. This restriction only applies to the primary font name as
66
+ presented to the users.
67
+
68
+ 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69
+ Software shall not be used to promote, endorse or advertise any
70
+ Modified Version, except to acknowledge the contribution(s) of the
71
+ Copyright Holder(s) and the Author(s) or with their explicit written
72
+ permission.
73
+
74
+ 5) The Font Software, modified or unmodified, in part or in whole,
75
+ must be distributed entirely under this license, and must not be
76
+ distributed under any other license. The requirement for fonts to
77
+ remain under this license does not apply to any document created
78
+ using the Font Software.
79
+
80
+ TERMINATION
81
+ This license becomes null and void if any of the above conditions are
82
+ not met.
83
+
84
+ DISCLAIMER
85
+ THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88
+ OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89
+ COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90
+ INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91
+ DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92
+ FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93
+ OTHER DEALINGS IN THE FONT SOFTWARE.
package/fonts/OFL-RedHatMono.txt ADDED
@@ -0,0 +1,93 @@
1
+ Copyright 2024 The Red Hat Project Authors (https://github.com/RedHatOfficial/RedHatFont)
2
+
3
+ This Font Software is licensed under the SIL Open Font License, Version 1.1.
4
+ This license is copied below, and is also available with a FAQ at:
5
+ https://openfontlicense.org
6
+
7
+
8
+ -----------------------------------------------------------
9
+ SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10
+ -----------------------------------------------------------
11
+
12
+ PREAMBLE
13
+ The goals of the Open Font License (OFL) are to stimulate worldwide
14
+ development of collaborative font projects, to support the font creation
15
+ efforts of academic and linguistic communities, and to provide a free and
16
+ open framework in which fonts may be shared and improved in partnership
17
+ with others.
18
+
19
+ The OFL allows the licensed fonts to be used, studied, modified and
20
+ redistributed freely as long as they are not sold by themselves. The
21
+ fonts, including any derivative works, can be bundled, embedded,
22
+ redistributed and/or sold with any software provided that any reserved
23
+ names are not used by derivative works. The fonts and derivatives,
24
+ however, cannot be released under any other type of license. The
25
+ requirement for fonts to remain under this license does not apply
26
+ to any document created using the fonts or their derivatives.
27
+
28
+ DEFINITIONS
29
+ "Font Software" refers to the set of files released by the Copyright
30
+ Holder(s) under this license and clearly marked as such. This may
31
+ include source files, build scripts and documentation.
32
+
33
+ "Reserved Font Name" refers to any names specified as such after the
34
+ copyright statement(s).
35
+
36
+ "Original Version" refers to the collection of Font Software components as
37
+ distributed by the Copyright Holder(s).
38
+
39
+ "Modified Version" refers to any derivative made by adding to, deleting,
40
+ or substituting -- in part or in whole -- any of the components of the
41
+ Original Version, by changing formats or by porting the Font Software to a
42
+ new environment.
43
+
44
+ "Author" refers to any designer, engineer, programmer, technical
45
+ writer or other person who contributed to the Font Software.
46
+
47
+ PERMISSION & CONDITIONS
48
+ Permission is hereby granted, free of charge, to any person obtaining
49
+ a copy of the Font Software, to use, study, copy, merge, embed, modify,
50
+ redistribute, and sell modified and unmodified copies of the Font
51
+ Software, subject to the following conditions:
52
+
53
+ 1) Neither the Font Software nor any of its individual components,
54
+ in Original or Modified Versions, may be sold by itself.
55
+
56
+ 2) Original or Modified Versions of the Font Software may be bundled,
57
+ redistributed and/or sold with any software, provided that each copy
58
+ contains the above copyright notice and this license. These can be
59
+ included either as stand-alone text files, human-readable headers or
60
+ in the appropriate machine-readable metadata fields within text or
61
+ binary files as long as those fields can be easily viewed by the user.
62
+
63
+ 3) No Modified Version of the Font Software may use the Reserved Font
64
+ Name(s) unless explicit written permission is granted by the corresponding
65
+ Copyright Holder. This restriction only applies to the primary font name as
66
+ presented to the users.
67
+
68
+ 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69
+ Software shall not be used to promote, endorse or advertise any
70
+ Modified Version, except to acknowledge the contribution(s) of the
71
+ Copyright Holder(s) and the Author(s) or with their explicit written
72
+ permission.
73
+
74
+ 5) The Font Software, modified or unmodified, in part or in whole,
75
+ must be distributed entirely under this license, and must not be
76
+ distributed under any other license. The requirement for fonts to
77
+ remain under this license does not apply to any document created
78
+ using the Font Software.
79
+
80
+ TERMINATION
81
+ This license becomes null and void if any of the above conditions are
82
+ not met.
83
+
84
+ DISCLAIMER
85
+ THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88
+ OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89
+ COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90
+ INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91
+ DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92
+ FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93
+ OTHER DEALINGS IN THE FONT SOFTWARE.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dbtour-addon-explorer",
3
- "version": "0.2.0",
3
+ "version": "0.2.4",
4
4
  "description": "The dbtour page: search, table view and neighbourhood diagrams in one HTML file that opens without a server.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -14,15 +14,19 @@
14
14
  "node": ">=22.18"
15
15
  },
16
16
  "exports": {
17
- ".": "./src/index.ts"
17
+ ".": {
18
+ "types": "./dist/index.d.ts",
19
+ "default": "./dist/index.js"
20
+ }
18
21
  },
19
22
  "files": [
20
- "src/index.ts",
21
- "dist"
23
+ "dist",
24
+ "fonts/OFL-Archivo.txt",
25
+ "fonts/OFL-RedHatMono.txt"
22
26
  ],
23
27
  "scripts": {
24
- "build": "node build.mjs",
25
- "prepack": "node build.mjs"
28
+ "build": "node ../../scripts/build.mjs",
29
+ "prepack": "node ../../scripts/build.mjs"
26
30
  },
27
31
  "keywords": [
28
32
  "dbtour",
@@ -36,7 +40,7 @@
36
40
  "@types/react": "^19.3.0",
37
41
  "@types/react-dom": "^19.3.0",
38
42
  "@xyflow/react": "^12.12.0",
39
- "dbtour": "0.2.0",
43
+ "dbtour": "0.2.4",
40
44
  "elkjs": "^0.12.1",
41
45
  "esbuild": "^0.28.2",
42
46
  "react": "^19.3.1",
package/src/index.ts DELETED
@@ -1,47 +0,0 @@
1
- // The explorer add-on: render(model) returns index.html with the page and the model inlined, so the file
2
- // opens from disk with no server and no network. The page itself is built from src/page into dist/.
3
- import { readFileSync } from 'node:fs';
4
- import type { Model } from 'dbtour/model';
5
- import { markDataUri } from './mark.ts';
6
-
7
- export function render(model: Model): Record<string, string> {
8
- return { 'index.html': pageHtml(model, builtFile('page.js'), builtFile('page.css')) };
9
- }
10
-
11
- function builtFile(name: string): string {
12
- try {
13
- return readFileSync(new URL(`../dist/${name}`, import.meta.url), 'utf8');
14
- } catch (error) {
15
- throw new Error(`dbtour-addon-explorer has no dist/${name}: in the dbtour repository run npm run build, otherwise reinstall the package`, { cause: error });
16
- }
17
- }
18
-
19
- /** The HTML around the bundle and the model. Pure, so it is tested without the build. */
20
- export function pageHtml(model: Model, js: string, css: string): string {
21
- const title = `${model.databases.map((d) => d.name).join(', ') || 'dbtour'} · dbtour`;
22
- // Inside a JSON string "<" is "<", so no "</script" or "<!--" can end the element early. The bundle
23
- // gets the same treatment where "</script" could appear inside one of its strings or patterns.
24
- const json = JSON.stringify(model).replace(/</g, '\\u003c');
25
- const script = js.replace(/<\/(script)/gi, '<\\/$1');
26
- return `<!doctype html>
27
- <html lang="en">
28
- <head>
29
- <meta charset="utf-8">
30
- <meta name="viewport" content="width=device-width, initial-scale=1">
31
- <meta name="color-scheme" content="light dark">
32
- <title>${escapeHtml(title)}</title>
33
- <link rel="icon" href="${markDataUri()}">
34
- <style>${css}</style>
35
- </head>
36
- <body>
37
- <div id="app"></div>
38
- <script id="dbtour-model" type="application/json">${json}</script>
39
- <script>${script}</script>
40
- </body>
41
- </html>
42
- `;
43
- }
44
-
45
- function escapeHtml(text: string): string {
46
- return text.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
47
- }