@fraqjs/plugin-takumi 0.1.1 → 0.1.2

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 (4) hide show
  1. package/dist/index.d.mts +4 -3
  2. package/dist/index.mjs +16 -11
  3. package/fonts/OFL.txt +93 -93
  4. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -16,12 +16,12 @@ interface PathBasedFontDetails {
16
16
  style?: 'normal' | 'italic' | 'oblique' | `oblique ${number}deg` | (string & {});
17
17
  }
18
18
  declare class TakumiService implements Disposable {
19
- private readonly ctx;
19
+ private readonly ctx?;
20
20
  readonly renderer: Renderer;
21
21
  private readonly abortController;
22
22
  private readonly registeredFontFamilies;
23
23
  private onFontRegisterConflict;
24
- constructor(ctx: Context, options: TakumiServiceOptions);
24
+ constructor(options?: TakumiServiceOptions, ctx?: Context | undefined);
25
25
  registerFontFamily(family: string, fonts: (string | PathBasedFontDetails | Font)[], signal?: AbortSignal): Promise<void>;
26
26
  renderJsx(jsx: ReactNode | ReactElementLike, renderOptions?: RenderOptions, signal?: AbortSignal): Promise<Buffer>;
27
27
  renderJsxWithEmoji(jsx: ReactNode | ReactElementLike, renderOptions?: RenderOptions, signal?: AbortSignal, emojiType?: EmojiType): Promise<Buffer>;
@@ -35,6 +35,7 @@ declare class TakumiService implements Disposable {
35
35
  interface TakumiPluginOptions extends TakumiServiceOptions {
36
36
  loadBuiltinFonts?: boolean;
37
37
  }
38
+ declare function loadBuiltinFontsForService(service: TakumiService): Promise<void>;
38
39
  declare const TakumiPlugin: import("@fraqjs/fraq").Plugin<[options?: TakumiPluginOptions | undefined], import("@fraqjs/fraq").Injection | undefined, import("@fraqjs/fraq").Injection | undefined>;
39
40
  //#endregion
40
- export { PathBasedFontDetails, TakumiPlugin, TakumiPlugin as default, TakumiPluginOptions, TakumiService, TakumiServiceOptions };
41
+ export { PathBasedFontDetails, TakumiPlugin, TakumiPlugin as default, TakumiPluginOptions, TakumiService, TakumiServiceOptions, loadBuiltinFontsForService };
package/dist/index.mjs CHANGED
@@ -23,19 +23,21 @@ var TakumiService = class {
23
23
  abortController = new AbortController();
24
24
  registeredFontFamilies = /* @__PURE__ */ new Set();
25
25
  onFontRegisterConflict;
26
- constructor(ctx, options) {
26
+ constructor(options, ctx) {
27
27
  this.ctx = ctx;
28
- this.renderer = new Renderer(options.renderer);
29
- this.onFontRegisterConflict = options.onFontRegisterConflict ?? "warn-and-ignore";
28
+ this.renderer = new Renderer(options?.renderer);
29
+ this.onFontRegisterConflict = options?.onFontRegisterConflict ?? "warn-and-ignore";
30
30
  }
31
31
  async registerFontFamily(family, fonts, signal) {
32
32
  if (this.registeredFontFamilies.has(family)) {
33
33
  const message = `Font family "${family}" has already been registered.`;
34
34
  if (this.onFontRegisterConflict === "error") throw new Error(message);
35
35
  else if (this.onFontRegisterConflict === "warn-and-ignore") {
36
- this.ctx.logger.warn(`${message} Ignoring new registration.`);
36
+ if (this.ctx) this.ctx.logger.warn(`${message} Ignoring new registration.`);
37
+ else console.warn(`${message} Ignoring new registration.`);
37
38
  return;
38
- } else if (this.onFontRegisterConflict === "warn-and-replace") this.ctx.logger.warn(`${message} Replacing previous registration.`);
39
+ } else if (this.onFontRegisterConflict === "warn-and-replace") if (this.ctx) this.ctx.logger.warn(`${message} Replacing previous registration.`);
40
+ else console.warn(`${message} Replacing previous registration.`);
39
41
  }
40
42
  await this.renderer.loadFonts(await Promise.all(fonts.map(async (font) => {
41
43
  if (typeof font === "string") return {
@@ -91,20 +93,23 @@ var TakumiService = class {
91
93
  };
92
94
  //#endregion
93
95
  //#region src/index.ts
96
+ async function loadBuiltinFontsForService(service) {
97
+ const require = createRequire(import.meta.url);
98
+ await service.registerFontFamily("Inter", [require.resolve("../fonts/Inter-VariableFont_opsz,wght.ttf"), require.resolve("../fonts/Inter-Italic-VariableFont_opsz,wght.ttf")]);
99
+ await service.registerFontFamily("Roboto Mono", [require.resolve("../fonts/RobotoMono-VariableFont_wght.ttf"), require.resolve("../fonts/RobotoMono-Italic-VariableFont_wght.ttf")]);
100
+ await service.registerFontFamily("Noto Sans SC", [require.resolve("../fonts/NotoSansSC-VariableFont_wght.ttf")]);
101
+ }
94
102
  const TakumiPlugin = definePlugin({
95
103
  name: "takumi",
96
104
  provides: [TakumiService],
97
105
  async apply(ctx, options) {
98
- const service = new TakumiService(ctx, options ?? {});
106
+ const service = new TakumiService(options, ctx);
99
107
  if (options?.loadBuiltinFonts ?? true) {
100
108
  ctx.logger.debug("Loading built-in fonts...");
101
- const require = createRequire(import.meta.url);
102
- await service.registerFontFamily("Inter", [require.resolve("../fonts/Inter-VariableFont_opsz,wght.ttf"), require.resolve("../fonts/Inter-Italic-VariableFont_opsz,wght.ttf")]);
103
- await service.registerFontFamily("Roboto Mono", [require.resolve("../fonts/RobotoMono-VariableFont_wght.ttf"), require.resolve("../fonts/RobotoMono-Italic-VariableFont_wght.ttf")]);
104
- await service.registerFontFamily("Noto Sans SC", [require.resolve("../fonts/NotoSansSC-VariableFont_wght.ttf")]);
109
+ await loadBuiltinFontsForService(service);
105
110
  }
106
111
  ctx.provide(TakumiService, service);
107
112
  }
108
113
  });
109
114
  //#endregion
110
- export { TakumiPlugin, TakumiPlugin as default, TakumiService };
115
+ export { TakumiPlugin, TakumiPlugin as default, TakumiService, loadBuiltinFontsForService };
package/fonts/OFL.txt CHANGED
@@ -1,93 +1,93 @@
1
- Copyright 2014-2021 Adobe (http://www.adobe.com/), with Reserved Font Name 'Source'
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.
1
+ Copyright 2014-2021 Adobe (http://www.adobe.com/), with Reserved Font Name 'Source'
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,7 +1,7 @@
1
1
  {
2
2
  "name": "@fraqjs/plugin-takumi",
3
3
  "type": "module",
4
- "version": "0.1.1",
4
+ "version": "0.1.2",
5
5
  "description": "Takumi integration plugin for Fraq",
6
6
  "files": [
7
7
  "dist",