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

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 +166 -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,170 @@
1
1
  # @twin.org/qr - Changelog
2
2
 
3
- ## 0.0.1-next.6
3
+ ## [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)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **qr:** Synchronize repo versions
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/core bumped from 0.0.1-next.59 to 0.0.1-next.60
16
+ * @twin.org/image bumped from 0.0.1-next.59 to 0.0.1-next.60
17
+
18
+ ## [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)
19
+
20
+
21
+ ### Miscellaneous Chores
22
+
23
+ * **qr:** Synchronize repo versions
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @twin.org/core bumped from 0.0.1-next.58 to 0.0.1-next.59
31
+ * @twin.org/image bumped from 0.0.1-next.58 to 0.0.1-next.59
32
+
33
+ ## [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)
34
+
35
+
36
+ ### Miscellaneous Chores
37
+
38
+ * **qr:** Synchronize repo versions
39
+
40
+
41
+ ### Dependencies
42
+
43
+ * The following workspace dependencies were updated
44
+ * dependencies
45
+ * @twin.org/core bumped from 0.0.1-next.57 to 0.0.1-next.58
46
+ * @twin.org/image bumped from 0.0.1-next.57 to 0.0.1-next.58
47
+
48
+ ## [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)
49
+
50
+
51
+ ### Features
52
+
53
+ * add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
54
+
55
+
56
+ ### Dependencies
57
+
58
+ * The following workspace dependencies were updated
59
+ * dependencies
60
+ * @twin.org/core bumped from 0.0.1-next.56 to 0.0.1-next.57
61
+ * @twin.org/image bumped from 0.0.1-next.56 to 0.0.1-next.57
62
+
63
+ ## [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)
64
+
65
+
66
+ ### Miscellaneous Chores
67
+
68
+ * **qr:** Synchronize repo versions
69
+
70
+
71
+ ### Dependencies
72
+
73
+ * The following workspace dependencies were updated
74
+ * dependencies
75
+ * @twin.org/core bumped from 0.0.1-next.55 to 0.0.1-next.56
76
+ * @twin.org/image bumped from 0.0.1-next.55 to 0.0.1-next.56
77
+
78
+ ## [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)
79
+
80
+
81
+ ### Miscellaneous Chores
82
+
83
+ * **qr:** Synchronize repo versions
84
+
85
+
86
+ ### Dependencies
87
+
88
+ * The following workspace dependencies were updated
89
+ * dependencies
90
+ * @twin.org/core bumped from 0.0.1-next.54 to 0.0.1-next.55
91
+ * @twin.org/image bumped from 0.0.1-next.54 to 0.0.1-next.55
92
+
93
+ ## [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)
94
+
95
+
96
+ ### Miscellaneous Chores
97
+
98
+ * **qr:** Synchronize repo versions
99
+
100
+
101
+ ### Dependencies
102
+
103
+ * The following workspace dependencies were updated
104
+ * dependencies
105
+ * @twin.org/core bumped from 0.0.1-next.53 to 0.0.1-next.54
106
+ * @twin.org/image bumped from 0.0.1-next.53 to 0.0.1-next.54
107
+
108
+ ## [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)
109
+
110
+
111
+ ### Miscellaneous Chores
112
+
113
+ * **qr:** Synchronize repo versions
114
+
115
+
116
+ ### Dependencies
117
+
118
+ * The following workspace dependencies were updated
119
+ * dependencies
120
+ * @twin.org/core bumped from 0.0.1-next.52 to 0.0.1-next.53
121
+ * @twin.org/image bumped from 0.0.1-next.52 to 0.0.1-next.53
122
+
123
+ ## [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)
124
+
125
+
126
+ ### Features
127
+
128
+ * use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
129
+
130
+
131
+ ### Dependencies
132
+
133
+ * The following workspace dependencies were updated
134
+ * dependencies
135
+ * @twin.org/core bumped from 0.0.1-next.51 to 0.0.1-next.52
136
+ * @twin.org/image bumped from 0.0.1-next.51 to 0.0.1-next.52
137
+
138
+ ## [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)
139
+
140
+
141
+ ### Miscellaneous Chores
142
+
143
+ * **qr:** Synchronize repo versions
144
+
145
+
146
+ ### Dependencies
147
+
148
+ * The following workspace dependencies were updated
149
+ * dependencies
150
+ * @twin.org/core bumped from 0.0.1-next.50 to 0.0.1-next.51
151
+ * @twin.org/image bumped from 0.0.1-next.50 to 0.0.1-next.51
152
+
153
+ ## [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)
154
+
155
+
156
+ ### Miscellaneous Chores
157
+
158
+ * **qr:** Synchronize repo versions
159
+
160
+
161
+ ### Dependencies
162
+
163
+ * The following workspace dependencies were updated
164
+ * dependencies
165
+ * @twin.org/core bumped from 0.0.1-next.49 to 0.0.1-next.50
166
+ * @twin.org/image bumped from 0.0.1-next.49 to 0.0.1-next.50
167
+
168
+ ## 0.0.1-next.49
4
169
 
5
170
  - 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.60",
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.60",
18
+ "@twin.org/image": "0.0.1-next.60",
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": [