@apiverve/barcodegenerator 1.1.12 → 1.1.13

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.
package/README.md CHANGED
@@ -5,8 +5,9 @@ Barcode Generator is a simple tool for generating barcodes from data. It returns
5
5
  ![Build Status](https://img.shields.io/badge/build-passing-green)
6
6
  ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
7
7
  ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
8
+ [![npm version](https://img.shields.io/npm/v/@apiverve/barcodegenerator.svg)](https://www.npmjs.com/package/@apiverve/barcodegenerator)
8
9
 
9
- This is a Javascript Wrapper for the [Barcode Generator API](https://apiverve.com/marketplace/barcodegenerator)
10
+ This is a Javascript Wrapper for the [Barcode Generator API](https://apiverve.com/marketplace/barcodegenerator?utm_source=npm&utm_medium=readme)
10
11
 
11
12
  ---
12
13
 
@@ -27,15 +28,15 @@ yarn add @apiverve/barcodegenerator
27
28
  ## Configuration
28
29
 
29
30
  Before using the Barcode Generator API client, you have to setup your account and obtain your API Key.
30
- You can get it by signing up at [https://apiverve.com](https://apiverve.com)
31
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=readme)
31
32
 
32
33
  ---
33
34
 
34
35
  ## Quick Start
35
36
 
36
- [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
37
+ [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=readme)
37
38
 
38
- The Barcode Generator API documentation is found here: [https://docs.apiverve.com/ref/barcodegenerator](https://docs.apiverve.com/ref/barcodegenerator).
39
+ The Barcode Generator API documentation is found here: [https://docs.apiverve.com/ref/barcodegenerator](https://docs.apiverve.com/ref/barcodegenerator?utm_source=npm&utm_medium=readme).
39
40
  You can find parameters, example responses, and status codes documented here.
40
41
 
41
42
  ### Setup
@@ -146,7 +147,7 @@ async function makeRequest() {
146
147
 
147
148
  ## Customer Support
148
149
 
149
- Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
150
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=readme).
150
151
 
151
152
  ---
152
153
 
@@ -158,14 +159,14 @@ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Tw
158
159
 
159
160
  ## Legal
160
161
 
161
- All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
162
+ All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=npm&utm_medium=readme), [Privacy Policy](https://apiverve.com/privacy?utm_source=npm&utm_medium=readme), and [Refund Policy](https://apiverve.com/refund?utm_source=npm&utm_medium=readme).
162
163
 
163
164
  ---
164
165
 
165
166
  ## License
166
167
  Licensed under the The MIT License (MIT)
167
168
 
168
- Copyright (©) 2025 APIVerve, and EvlarSoft LLC
169
+ Copyright (©) 2026 APIVerve, and EvlarSoft LLC
169
170
 
170
171
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
171
172
 
package/index.js CHANGED
@@ -34,6 +34,102 @@ class barcodegeneratorWrapper {
34
34
 
35
35
  // secure is deprecated, all requests must be made over HTTPS
36
36
  this.baseURL = 'https://api.apiverve.com/v1/barcodegenerator';
37
+
38
+ // Validation rules for parameters (generated from schema)
39
+ this.validationRules = {"data":{"type":"string","required":true},"type":{"type":"string","required":true},"lineColor":{"type":"string","required":false},"backgroundColor":{"type":"string","required":false},"displayValue":{"type":"boolean","required":false}};
40
+ }
41
+
42
+ /**
43
+ * Validate query parameters against schema rules
44
+ * @param {Object} query - The query parameters to validate
45
+ * @throws {Error} - If validation fails
46
+ */
47
+ validateParams(query) {
48
+ const errors = [];
49
+
50
+ for (const [paramName, rules] of Object.entries(this.validationRules)) {
51
+ const value = query[paramName];
52
+
53
+ // Check required
54
+ if (rules.required && (value === undefined || value === null || value === '')) {
55
+ errors.push(`Required parameter [${paramName}] is missing.`);
56
+ continue;
57
+ }
58
+
59
+ // Skip validation if value is not provided and not required
60
+ if (value === undefined || value === null) {
61
+ continue;
62
+ }
63
+
64
+ // Type validation
65
+ if (rules.type === 'integer' || rules.type === 'number') {
66
+ const numValue = Number(value);
67
+ if (isNaN(numValue)) {
68
+ errors.push(`Parameter [${paramName}] must be a valid ${rules.type}.`);
69
+ continue;
70
+ }
71
+
72
+ if (rules.type === 'integer' && !Number.isInteger(numValue)) {
73
+ errors.push(`Parameter [${paramName}] must be an integer.`);
74
+ continue;
75
+ }
76
+
77
+ // Min/max validation for numbers
78
+ if (rules.min !== undefined && numValue < rules.min) {
79
+ errors.push(`Parameter [${paramName}] must be at least ${rules.min}.`);
80
+ }
81
+ if (rules.max !== undefined && numValue > rules.max) {
82
+ errors.push(`Parameter [${paramName}] must be at most ${rules.max}.`);
83
+ }
84
+ } else if (rules.type === 'string') {
85
+ if (typeof value !== 'string') {
86
+ errors.push(`Parameter [${paramName}] must be a string.`);
87
+ continue;
88
+ }
89
+
90
+ // Length validation for strings
91
+ if (rules.minLength !== undefined && value.length < rules.minLength) {
92
+ errors.push(`Parameter [${paramName}] must be at least ${rules.minLength} characters.`);
93
+ }
94
+ if (rules.maxLength !== undefined && value.length > rules.maxLength) {
95
+ errors.push(`Parameter [${paramName}] must be at most ${rules.maxLength} characters.`);
96
+ }
97
+
98
+ // Format validation
99
+ if (rules.format) {
100
+ const formatPatterns = {
101
+ 'email': /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
102
+ 'url': /^https?:\/\/.+/i,
103
+ 'ip': /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
104
+ 'date': /^\d{4}-\d{2}-\d{2}$/,
105
+ 'hexColor': /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
106
+ };
107
+
108
+ if (formatPatterns[rules.format] && !formatPatterns[rules.format].test(value)) {
109
+ errors.push(`Parameter [${paramName}] must be a valid ${rules.format}.`);
110
+ }
111
+ }
112
+ } else if (rules.type === 'boolean') {
113
+ if (typeof value !== 'boolean' && value !== 'true' && value !== 'false') {
114
+ errors.push(`Parameter [${paramName}] must be a boolean.`);
115
+ }
116
+ } else if (rules.type === 'array') {
117
+ if (!Array.isArray(value)) {
118
+ errors.push(`Parameter [${paramName}] must be an array.`);
119
+ }
120
+ }
121
+
122
+ // Enum validation
123
+ if (rules.enum && Array.isArray(rules.enum)) {
124
+ if (!rules.enum.includes(value)) {
125
+ errors.push(`Parameter [${paramName}] must be one of: ${rules.enum.join(', ')}.`);
126
+ }
127
+ }
128
+ }
129
+
130
+ if (errors.length > 0) {
131
+ throw new Error(`Validation failed: ${errors.join(' ')} See documentation: https://docs.apiverve.com/ref/barcodegenerator`);
132
+ }
37
133
  }
38
134
 
39
135
  async execute(query, callback) {
@@ -58,14 +154,8 @@ class barcodegeneratorWrapper {
58
154
  }
59
155
  }
60
156
 
61
- var requiredParams = ["data","type"];
62
- if (requiredParams.length > 0) {
63
- for (var i = 0; i < requiredParams.length; i++) {
64
- if (!query[requiredParams[i]]) {
65
- throw new Error(`Required parameter [${requiredParams[i]}] is missing. See documentation: https://docs.apiverve.com/ref/barcodegenerator`);
66
- }
67
- }
68
- }
157
+ // Validate parameters against schema rules
158
+ this.validateParams(query);
69
159
 
70
160
  const method = 'POST';
71
161
  const url = method === 'POST' ? this.baseURL : this.constructURL(query);
@@ -108,7 +198,7 @@ class barcodegeneratorWrapper {
108
198
  constructURL(query) {
109
199
  let url = this.baseURL;
110
200
 
111
- if(query && typeof query === 'object')
201
+ if(query && typeof query === 'object')
112
202
  {
113
203
  if (Object.keys(query).length > 0) {
114
204
  const queryString = Object.keys(query)
@@ -119,6 +209,7 @@ class barcodegeneratorWrapper {
119
209
  }
120
210
  return url;
121
211
  }
212
+
122
213
  }
123
214
 
124
215
  module.exports = barcodegeneratorWrapper;
package/package.json CHANGED
@@ -1,9 +1,18 @@
1
1
  {
2
2
  "name": "@apiverve/barcodegenerator",
3
- "version": "1.1.12",
3
+ "version": "1.1.13",
4
4
  "description": "Barcode Generator is a simple tool for generating barcodes from data. It returns a URL to the generated image of the barcode.",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
+ "sideEffects": false,
8
+ "engines": {
9
+ "node": ">=14.0.0"
10
+ },
11
+ "files": [
12
+ "index.js",
13
+ "index.d.ts",
14
+ "LICENSE"
15
+ ],
7
16
  "scripts": {
8
17
  "test": "mocha",
9
18
  "example": "node examples/basic.js"
@@ -14,14 +23,18 @@
14
23
  "directory": "npm"
15
24
  },
16
25
  "keywords": [
17
- "barcode generator", "barcode generation", "barcode generate", "barcode api", "barcode tool"
26
+ ""
18
27
  ],
19
- "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
28
+ "author": {
29
+ "name": "APIVerve",
30
+ "email": "hello@apiverve.com",
31
+ "url": "https://apiverve.com"
32
+ },
20
33
  "license": "MIT",
21
34
  "bugs": {
22
35
  "url": "https://github.com/apiverve/barcodegenerator-api/issues"
23
36
  },
24
- "homepage": "https://apiverve.com/marketplace/barcodegenerator?utm_source=npm",
37
+ "homepage": "https://apiverve.com/marketplace/barcodegenerator?utm_source=npm&utm_medium=homepage",
25
38
  "devDependencies": {
26
39
  "mocha": "^11.0.1",
27
40
  "chai": "^5.1.2",
package/examples/basic.js DELETED
@@ -1,42 +0,0 @@
1
- /**
2
- * Basic Example - Barcode Generator API
3
- *
4
- * This example demonstrates how to use the Barcode Generator API.
5
- * Make sure to set your API key in the .env file or replace '[YOUR_API_KEY]' below.
6
- */
7
-
8
- require('dotenv').config();
9
- const barcodegeneratorAPI = require('../index.js');
10
-
11
- // Initialize the API client
12
- const api = new barcodegeneratorAPI({
13
- api_key: process.env.API_KEY || '[YOUR_API_KEY]'
14
- });
15
-
16
- // Example query
17
- var query = {
18
- "data": "51001544700",
19
- "type": "code128",
20
- "lineColor": "#000000",
21
- "backgroundColor": "#FFFFFF",
22
- "displayValue": true
23
- };
24
-
25
- // Make the API request using callback
26
- console.log('Making request to Barcode Generator API...\n');
27
-
28
- api.execute(query, function (error, data) {
29
- if (error) {
30
- console.error('Error occurred:');
31
- if (error.error) {
32
- console.error('Message:', error.error);
33
- console.error('Status:', error.status);
34
- } else {
35
- console.error(JSON.stringify(error, null, 2));
36
- }
37
- return;
38
- }
39
-
40
- console.log('Response:');
41
- console.log(JSON.stringify(data, null, 2));
42
- });
package/tmp/build.dat DELETED
@@ -1 +0,0 @@
1
- #