@twin.org/qr 0.0.1-next.6 → 0.0.1-next.62

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/docs/changelog.md +197 -1
  2. package/docs/reference/classes/JpegRenderer.md +11 -7
  3. package/docs/reference/classes/PngRenderer.md +11 -7
  4. package/docs/reference/classes/QR.md +18 -8
  5. package/docs/reference/classes/TextRenderer.md +10 -6
  6. package/docs/reference/type-aliases/ErrorCorrectLevel.md +1 -1
  7. package/docs/reference/type-aliases/QRCellData.md +1 -1
  8. package/package.json +5 -5
package/docs/changelog.md CHANGED
@@ -1,5 +1,201 @@
1
1
  # @twin.org/qr - Changelog
2
2
 
3
- ## 0.0.1-next.6
3
+ ## [0.0.1-next.62](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.61...qr-v0.0.1-next.62) (2025-06-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
9
+ * use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
10
+
11
+
12
+ ### Dependencies
13
+
14
+ * The following workspace dependencies were updated
15
+ * dependencies
16
+ * @twin.org/core bumped from 0.0.1-next.61 to 0.0.1-next.62
17
+ * @twin.org/image bumped from 0.0.1-next.61 to 0.0.1-next.62
18
+
19
+ ## [0.0.1-next.61](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.60...qr-v0.0.1-next.61) (2025-06-17)
20
+
21
+
22
+ ### Miscellaneous Chores
23
+
24
+ * **qr:** Synchronize repo versions
25
+
26
+
27
+ ### Dependencies
28
+
29
+ * The following workspace dependencies were updated
30
+ * dependencies
31
+ * @twin.org/core bumped from 0.0.1-next.60 to 0.0.1-next.61
32
+ * @twin.org/image bumped from 0.0.1-next.60 to 0.0.1-next.61
33
+
34
+ ## [0.0.1-next.60](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.59...qr-v0.0.1-next.60) (2025-06-17)
35
+
36
+
37
+ ### Miscellaneous Chores
38
+
39
+ * **qr:** Synchronize repo versions
40
+
41
+
42
+ ### Dependencies
43
+
44
+ * The following workspace dependencies were updated
45
+ * dependencies
46
+ * @twin.org/core bumped from 0.0.1-next.59 to 0.0.1-next.60
47
+ * @twin.org/image bumped from 0.0.1-next.59 to 0.0.1-next.60
48
+
49
+ ## [0.0.1-next.59](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.58...qr-v0.0.1-next.59) (2025-06-17)
50
+
51
+
52
+ ### Miscellaneous Chores
53
+
54
+ * **qr:** Synchronize repo versions
55
+
56
+
57
+ ### Dependencies
58
+
59
+ * The following workspace dependencies were updated
60
+ * dependencies
61
+ * @twin.org/core bumped from 0.0.1-next.58 to 0.0.1-next.59
62
+ * @twin.org/image bumped from 0.0.1-next.58 to 0.0.1-next.59
63
+
64
+ ## [0.0.1-next.58](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.57...qr-v0.0.1-next.58) (2025-06-13)
65
+
66
+
67
+ ### Miscellaneous Chores
68
+
69
+ * **qr:** Synchronize repo versions
70
+
71
+
72
+ ### Dependencies
73
+
74
+ * The following workspace dependencies were updated
75
+ * dependencies
76
+ * @twin.org/core bumped from 0.0.1-next.57 to 0.0.1-next.58
77
+ * @twin.org/image bumped from 0.0.1-next.57 to 0.0.1-next.58
78
+
79
+ ## [0.0.1-next.57](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.56...qr-v0.0.1-next.57) (2025-06-10)
80
+
81
+
82
+ ### Features
83
+
84
+ * add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
85
+
86
+
87
+ ### Dependencies
88
+
89
+ * The following workspace dependencies were updated
90
+ * dependencies
91
+ * @twin.org/core bumped from 0.0.1-next.56 to 0.0.1-next.57
92
+ * @twin.org/image bumped from 0.0.1-next.56 to 0.0.1-next.57
93
+
94
+ ## [0.0.1-next.56](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.55...qr-v0.0.1-next.56) (2025-05-08)
95
+
96
+
97
+ ### Miscellaneous Chores
98
+
99
+ * **qr:** Synchronize repo versions
100
+
101
+
102
+ ### Dependencies
103
+
104
+ * The following workspace dependencies were updated
105
+ * dependencies
106
+ * @twin.org/core bumped from 0.0.1-next.55 to 0.0.1-next.56
107
+ * @twin.org/image bumped from 0.0.1-next.55 to 0.0.1-next.56
108
+
109
+ ## [0.0.1-next.55](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.54...qr-v0.0.1-next.55) (2025-05-07)
110
+
111
+
112
+ ### Miscellaneous Chores
113
+
114
+ * **qr:** Synchronize repo versions
115
+
116
+
117
+ ### Dependencies
118
+
119
+ * The following workspace dependencies were updated
120
+ * dependencies
121
+ * @twin.org/core bumped from 0.0.1-next.54 to 0.0.1-next.55
122
+ * @twin.org/image bumped from 0.0.1-next.54 to 0.0.1-next.55
123
+
124
+ ## [0.0.1-next.54](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.53...qr-v0.0.1-next.54) (2025-05-06)
125
+
126
+
127
+ ### Miscellaneous Chores
128
+
129
+ * **qr:** Synchronize repo versions
130
+
131
+
132
+ ### Dependencies
133
+
134
+ * The following workspace dependencies were updated
135
+ * dependencies
136
+ * @twin.org/core bumped from 0.0.1-next.53 to 0.0.1-next.54
137
+ * @twin.org/image bumped from 0.0.1-next.53 to 0.0.1-next.54
138
+
139
+ ## [0.0.1-next.53](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.52...qr-v0.0.1-next.53) (2025-05-01)
140
+
141
+
142
+ ### Miscellaneous Chores
143
+
144
+ * **qr:** Synchronize repo versions
145
+
146
+
147
+ ### Dependencies
148
+
149
+ * The following workspace dependencies were updated
150
+ * dependencies
151
+ * @twin.org/core bumped from 0.0.1-next.52 to 0.0.1-next.53
152
+ * @twin.org/image bumped from 0.0.1-next.52 to 0.0.1-next.53
153
+
154
+ ## [0.0.1-next.52](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.51...qr-v0.0.1-next.52) (2025-04-17)
155
+
156
+
157
+ ### Features
158
+
159
+ * use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
160
+
161
+
162
+ ### Dependencies
163
+
164
+ * The following workspace dependencies were updated
165
+ * dependencies
166
+ * @twin.org/core bumped from 0.0.1-next.51 to 0.0.1-next.52
167
+ * @twin.org/image bumped from 0.0.1-next.51 to 0.0.1-next.52
168
+
169
+ ## [0.0.1-next.51](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.50...qr-v0.0.1-next.51) (2025-03-27)
170
+
171
+
172
+ ### Miscellaneous Chores
173
+
174
+ * **qr:** Synchronize repo versions
175
+
176
+
177
+ ### Dependencies
178
+
179
+ * The following workspace dependencies were updated
180
+ * dependencies
181
+ * @twin.org/core bumped from 0.0.1-next.50 to 0.0.1-next.51
182
+ * @twin.org/image bumped from 0.0.1-next.50 to 0.0.1-next.51
183
+
184
+ ## [0.0.1-next.50](https://github.com/twinfoundation/framework/compare/qr-v0.0.1-next.49...qr-v0.0.1-next.50) (2025-03-26)
185
+
186
+
187
+ ### Miscellaneous Chores
188
+
189
+ * **qr:** Synchronize repo versions
190
+
191
+
192
+ ### Dependencies
193
+
194
+ * The following workspace dependencies were updated
195
+ * dependencies
196
+ * @twin.org/core bumped from 0.0.1-next.49 to 0.0.1-next.50
197
+ * @twin.org/image bumped from 0.0.1-next.49 to 0.0.1-next.50
198
+
199
+ ## 0.0.1-next.49
4
200
 
5
201
  - Initial Release
package/docs/reference/classes/JpegRenderer.md CHANGED
@@ -4,34 +4,38 @@ Class to render qr data as jpeg.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new JpegRenderer()
7
+ ### Constructor
8
8
 
9
- > **new JpegRenderer**(): [`JpegRenderer`](JpegRenderer.md)
9
+ > **new JpegRenderer**(): `JpegRenderer`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`JpegRenderer`](JpegRenderer.md)
13
+ `JpegRenderer`
14
14
 
15
15
  ## Methods
16
16
 
17
17
  ### render()
18
18
 
19
- > `static` **render**(`cellData`, `options`?): `Promise`\<`Uint8Array`\>
19
+ > `static` **render**(`cellData`, `options?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
20
20
 
21
21
  Render the QR code data as a bitmap.
22
22
 
23
23
  #### Parameters
24
24
 
25
- • **cellData**: [`QRCellData`](../type-aliases/QRCellData.md)
25
+ ##### cellData
26
+
27
+ [`QRCellData`](../type-aliases/QRCellData.md)
26
28
 
27
29
  The cell data for the QR code.
28
30
 
29
- • **options?**: [`IBitmapRendererOptions`](../interfaces/IBitmapRendererOptions.md)
31
+ ##### options?
32
+
33
+ [`IBitmapRendererOptions`](../interfaces/IBitmapRendererOptions.md)
30
34
 
31
35
  The options for rendering.
32
36
 
33
37
  #### Returns
34
38
 
35
- `Promise`\<`Uint8Array`\>
39
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
36
40
 
37
41
  The bitmap content.
package/docs/reference/classes/PngRenderer.md CHANGED
@@ -4,34 +4,38 @@ Class to render qr data as png.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new PngRenderer()
7
+ ### Constructor
8
8
 
9
- > **new PngRenderer**(): [`PngRenderer`](PngRenderer.md)
9
+ > **new PngRenderer**(): `PngRenderer`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`PngRenderer`](PngRenderer.md)
13
+ `PngRenderer`
14
14
 
15
15
  ## Methods
16
16
 
17
17
  ### render()
18
18
 
19
- > `static` **render**(`cellData`, `options`?): `Promise`\<`Uint8Array`\>
19
+ > `static` **render**(`cellData`, `options?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
20
20
 
21
21
  Render the QR code data as a bitmap.
22
22
 
23
23
  #### Parameters
24
24
 
25
- • **cellData**: [`QRCellData`](../type-aliases/QRCellData.md)
25
+ ##### cellData
26
+
27
+ [`QRCellData`](../type-aliases/QRCellData.md)
26
28
 
27
29
  The cell data for the QR code.
28
30
 
29
- • **options?**: [`IBitmapRendererOptions`](../interfaces/IBitmapRendererOptions.md)
31
+ ##### options?
32
+
33
+ [`IBitmapRendererOptions`](../interfaces/IBitmapRendererOptions.md)
30
34
 
31
35
  The options for rendering.
32
36
 
33
37
  #### Returns
34
38
 
35
- `Promise`\<`Uint8Array`\>
39
+ `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
36
40
 
37
41
  The bitmap content.
package/docs/reference/classes/QR.md CHANGED
@@ -5,25 +5,29 @@ Based on https://github.com/kazuhikoarase/qrcode-generator/ .
5
5
 
6
6
  ## Constructors
7
7
 
8
- ### new QR()
8
+ ### Constructor
9
9
 
10
- > **new QR**(`typeNumber`, `errorCorrectLevel`): [`QR`](QR.md)
10
+ > **new QR**(`typeNumber`, `errorCorrectLevel`): `QR`
11
11
 
12
12
  Create a new instance of QR.
13
13
 
14
14
  #### Parameters
15
15
 
16
- • **typeNumber**: `number` = `6`
16
+ ##### typeNumber
17
+
18
+ `number` = `6`
17
19
 
18
20
  0 to 40, 0 means autodetect.
19
21
 
20
- • **errorCorrectLevel**: [`ErrorCorrectLevel`](../type-aliases/ErrorCorrectLevel.md) = `ErrorCorrectLevel.L`
22
+ ##### errorCorrectLevel
23
+
24
+ [`ErrorCorrectLevel`](../type-aliases/ErrorCorrectLevel.md) = `ErrorCorrectLevel.L`
21
25
 
22
26
  'L','M','Q','H'.
23
27
 
24
28
  #### Returns
25
29
 
26
- [`QR`](QR.md)
30
+ `QR`
27
31
 
28
32
  #### Throws
29
33
 
@@ -39,7 +43,9 @@ Add text data to the QR Code.
39
43
 
40
44
  #### Parameters
41
45
 
42
- • **qrData**: `string`
46
+ ##### qrData
47
+
48
+ `string`
43
49
 
44
50
  The data to add.
45
51
 
@@ -57,7 +63,9 @@ Add number to the QR Code.
57
63
 
58
64
  #### Parameters
59
65
 
60
- • **qrData**: `string`
66
+ ##### qrData
67
+
68
+ `string`
61
69
 
62
70
  The data to add.
63
71
 
@@ -75,7 +83,9 @@ Add alpha numeric to the QR Code.
75
83
 
76
84
  #### Parameters
77
85
 
78
- • **qrData**: `string`
86
+ ##### qrData
87
+
88
+ `string`
79
89
 
80
90
  The data to add.
81
91
 
package/docs/reference/classes/TextRenderer.md CHANGED
@@ -4,29 +4,33 @@ Class to render qr data as text.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new TextRenderer()
7
+ ### Constructor
8
8
 
9
- > **new TextRenderer**(): [`TextRenderer`](TextRenderer.md)
9
+ > **new TextRenderer**(): `TextRenderer`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`TextRenderer`](TextRenderer.md)
13
+ `TextRenderer`
14
14
 
15
15
  ## Methods
16
16
 
17
17
  ### render()
18
18
 
19
- > `static` **render**(`cellData`, `options`?): `Promise`\<`string`\>
19
+ > `static` **render**(`cellData`, `options?`): `Promise`\<`string`\>
20
20
 
21
21
  Render the QR code data as text.
22
22
 
23
23
  #### Parameters
24
24
 
25
- • **cellData**: [`QRCellData`](../type-aliases/QRCellData.md)
25
+ ##### cellData
26
+
27
+ [`QRCellData`](../type-aliases/QRCellData.md)
26
28
 
27
29
  The cell data for the QR code.
28
30
 
29
- • **options?**: [`ITextRendererOptions`](../interfaces/ITextRendererOptions.md)
31
+ ##### options?
32
+
33
+ [`ITextRendererOptions`](../interfaces/ITextRendererOptions.md)
30
34
 
31
35
  The options for rendering.
32
36
 
package/docs/reference/type-aliases/ErrorCorrectLevel.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Type Alias: ErrorCorrectLevel
2
2
 
3
- > **ErrorCorrectLevel**: *typeof* [`ErrorCorrectLevel`](../variables/ErrorCorrectLevel.md)\[keyof *typeof* [`ErrorCorrectLevel`](../variables/ErrorCorrectLevel.md)\]
3
+ > **ErrorCorrectLevel** = *typeof* [`ErrorCorrectLevel`](../variables/ErrorCorrectLevel.md)\[keyof *typeof* [`ErrorCorrectLevel`](../variables/ErrorCorrectLevel.md)\]
4
4
 
5
5
  Error correction level to use for the QR Code.
6
6
  Based on https://github.com/kazuhikoarase/qrcode-generator/ .
package/docs/reference/type-aliases/QRCellData.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # Type Alias: QRCellData
2
2
 
3
- > **QRCellData**: (`boolean` \| `null`)[][]
3
+ > **QRCellData** = (`boolean` \| `null`)[][]
4
4
 
5
5
  Definition of type for QR Code Cell data.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/qr",
3
- "version": "0.0.1-next.6",
3
+ "version": "0.0.1-next.62",
4
4
  "description": "Package for creating QR codes",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,8 +14,8 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "0.0.1-next.6",
18
- "@twin.org/image": "0.0.1-next.6",
17
+ "@twin.org/core": "0.0.1-next.62",
18
+ "@twin.org/image": "0.0.1-next.62",
19
19
  "@twin.org/nameof": "next"
20
20
  },
21
21
  "main": "./dist/cjs/index.cjs",
@@ -23,9 +23,9 @@
23
23
  "types": "./dist/types/index.d.ts",
24
24
  "exports": {
25
25
  ".": {
26
+ "types": "./dist/types/index.d.ts",
26
27
  "require": "./dist/cjs/index.cjs",
27
- "import": "./dist/esm/index.mjs",
28
- "types": "./dist/types/index.d.ts"
28
+ "import": "./dist/esm/index.mjs"
29
29
  }
30
30
  },
31
31
  "files": [