qlcodes 1.1.1 → 1.1.3

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 (2) hide show
  1. package/README.md +34 -16
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,24 +2,17 @@
2
2
 
3
3
  A small utility that unifies SQL codes describing states (SQLSTATE) from different DBMS into a single, normalized structure through a curated dataset constructed at build time.
4
4
 
5
- The module is built from authoritative vendor documentation (IBM, PostgreSQL, Oracle) and generates static reference data at build time. Find references bellow.
6
-
7
- ## References
8
-
9
- - IBM
10
- [Listing of SQLSTATE values](https://www.ibm.com/docs/en/i/7.6.0?topic=codes-listing-sqlstate-values#cc__classcode00)
11
- (Last Updated: 2025-09-29)
12
-
13
- - Postgres codes
14
- [Appendix A. PostgreSQL Error Codes](https://www.postgresql.org/docs/10/static/errcodes-appendix.html)
15
- (V.10)
5
+ The module is built from authoritative vendor documentation (IBM, PostgreSQL, Oracle) and generates static reference data at build time. [Find references bellow](/#user-content-references).
16
6
 
7
+ ## SQLSTATES coverage
17
8
 
18
- - Oracle
19
- [Oracle appendix](https://docs.oracle.com/cd/E15817_01/appdev.111/b31228/appd.htm)
20
- 11g Release 1 (11.1)
9
+ The project aims to cover sql states for most of RDBMS [drivers supported by **Typeorm** such as Google Spanner](https://typeorm.io/docs/drivers/google-spanner).
10
+ Find bellow the actual coverage:
21
11
 
22
- ---
12
+ 🕓 MySQL | 🕓 MariaDB | ✅ PostgreSQL | 🕓 CockroachDB (Postgres-compatible)
13
+ 🕓 Microsoft SQL Server | ✅ Oracle | 🕓 SQLite | 🕓 SAP HANA | 🕓 Google Spanner
14
+ ✅ IBM*
15
+ >( \* ) IBM defines and publishes SQLSTATE codes as part of the SQL standard, so their The codes should covere IBM products such as DB2, IBM Informix, IBM Netezza, IBM i (AS/400) .
23
16
 
24
17
  ## Installation
25
18
 
@@ -116,6 +109,7 @@ Output:
116
109
  ## API
117
110
 
118
111
  `lens(code: string): QLLens`
112
+
119
113
  |Parameters|Returns|
120
114
  |-|-|
121
115
  |**code** SQLSTATE status code | A structured status description|
@@ -151,22 +145,46 @@ $ npm install
151
145
  > unless you know what you know what you are doing.
152
146
 
153
147
  3) Rebuild the module
148
+
154
149
  ```bash
155
150
  $ npm run build
156
151
  ```
157
152
 
158
153
  ### Quality of life
154
+
159
155
  You may pass argument to the build script to enforce a few behaviours to help you seing through the process...
156
+
160
157
  |argument|effect|
161
158
  |-|-|
162
159
  |`--debug`|prevents the cleanup of middle stage file created during the data processing|
163
160
  |`--make-keys`|allows the creation of keys when a description is given...through the 'generate' step (`generate.cjs`)|
164
161
 
162
+ Use your customized build via a local dependency or a forked package.
165
163
 
164
+ ---
166
165
 
167
- Use your customized build via a local dependency or a forked package.
166
+ ## Showcase
167
+
168
+ [in stackblitz](https://stackblitz.com/edit/stackblitz-starters-vjcs3q7x?file=index.js)
169
+
170
+ ---
171
+
172
+ ## References
173
+
174
+ - IBM
175
+ [Listing of SQLSTATE values](https://www.ibm.com/docs/en/i/7.6.0?topic=codes-listing-sqlstate-values#cc__classcode00)
176
+ (Last Updated: 2025-09-29)
177
+
178
+ - Postgres codes
179
+ [Appendix A. PostgreSQL Error Codes](https://www.postgresql.org/docs/10/static/errcodes-appendix.html)
180
+ (V.10)
181
+
182
+ - Oracle
183
+ [Oracle appendix](https://docs.oracle.com/cd/E15817_01/appdev.111/b31228/appd.htm)
184
+ 11g Release 1 (11.1)
168
185
 
169
186
  ---
170
187
 
171
188
  ## License
189
+
172
190
  [MIT 2025](https://github.com/ManuUseGitHub/QLCodes?tab=MIT-1-ov-file#readme)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "qlcodes",
3
- "version": "1.1.1",
3
+ "version": "1.1.3",
4
4
  "main": "src/index.mjs",
5
5
  "scripts": {
6
6
  "build": "chmod +x ./build.sh; ./build.sh"