@apiverve/wordscramble 1.1.14 → 1.2.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 (5) hide show
  1. package/LICENSE +20 -20
  2. package/README.md +172 -171
  3. package/index.d.ts +47 -28
  4. package/index.js +209 -209
  5. package/package.json +7 -8
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2025 APIVerve, and EvlarSoft LLC
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2026 APIVerve and EvlarSoft LLC
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
21
  SOFTWARE.
package/README.md CHANGED
@@ -1,196 +1,197 @@
1
- # Word Scramble Generator API
2
-
3
- Word Scramble Generator creates puzzles where players unscramble letters to form words, with optional hints from dictionary definitions.
4
-
5
- ![Build Status](https://img.shields.io/badge/build-passing-green)
6
- ![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
7
- ![Prod Ready](https://img.shields.io/badge/production-ready-blue)
8
- [![npm version](https://img.shields.io/npm/v/@apiverve/wordscramble.svg)](https://www.npmjs.com/package/@apiverve/wordscramble)
9
-
10
- This is a Javascript Wrapper for the [Word Scramble Generator API](https://apiverve.com/marketplace/wordscramble?utm_source=npm&utm_medium=readme)
11
-
12
- ---
13
-
14
- ## Installation
15
-
16
- Using npm:
17
- ```shell
18
- npm install @apiverve/wordscramble
19
- ```
20
-
21
- Using yarn:
22
- ```shell
23
- yarn add @apiverve/wordscramble
24
- ```
25
-
26
- ---
27
-
28
- ## Configuration
29
-
30
- Before using the Word Scramble Generator API client, you have to setup your account and obtain your API Key.
31
- You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=readme)
32
-
33
- ---
34
-
35
- ## Quick Start
36
-
37
- [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=readme)
38
-
39
- The Word Scramble Generator API documentation is found here: [https://docs.apiverve.com/ref/wordscramble](https://docs.apiverve.com/ref/wordscramble?utm_source=npm&utm_medium=readme).
40
- You can find parameters, example responses, and status codes documented here.
41
-
42
- ### Setup
43
-
44
- ```javascript
45
- const wordscrambleAPI = require('@apiverve/wordscramble');
46
- const api = new wordscrambleAPI({
47
- api_key: '[YOUR_API_KEY]'
48
- });
49
- ```
50
-
51
- ---
52
-
53
- ## Usage
54
-
55
- ---
56
-
57
- ### Perform Request
58
-
59
- Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.
60
-
61
- ```javascript
1
+ # Word Scramble Generator API
2
+
3
+ Word Scramble Generator is a scramble word API that creates puzzles where players unscramble letters to form words, returning each scrambled sequence with its answer and letter count.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/@apiverve/wordscramble.svg)](https://www.npmjs.com/package/@apiverve/wordscramble)
6
+
7
+ This is a JavaScript wrapper for the [Word Scramble Generator API](https://apiverve.com/marketplace/wordscramble?utm_source=npm&utm_medium=referral&utm_content=readme)
8
+
9
+ ---
10
+
11
+ ## Installation
12
+
13
+ Using npm:
14
+ ```shell
15
+ npm install @apiverve/wordscramble
16
+ ```
17
+
18
+ Using yarn:
19
+ ```shell
20
+ yarn add @apiverve/wordscramble
21
+ ```
22
+
23
+ ---
24
+
25
+ ## Configuration
26
+
27
+ Before using the Word Scramble Generator API client, you have to setup your account and obtain your API Key.
28
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=referral&utm_content=readme)
29
+
30
+ ---
31
+
32
+ ## Quick Start
33
+
34
+ [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=referral&utm_content=readme)
35
+
36
+ The Word Scramble Generator API documentation is found here: [https://docs.apiverve.com/ref/wordscramble](https://docs.apiverve.com/ref/wordscramble?utm_source=npm&utm_medium=referral&utm_content=readme).
37
+ You can find parameters, example responses, and status codes documented here.
38
+
39
+ ### Setup
40
+
41
+ ```javascript
42
+ const wordscrambleAPI = require('@apiverve/wordscramble');
43
+ const api = new wordscrambleAPI({
44
+ api_key: '[YOUR_API_KEY]'
45
+ });
46
+ ```
47
+
48
+ ---
49
+
50
+ ## Usage
51
+
52
+ ---
53
+
54
+ ### Perform Request
55
+
56
+ Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.
57
+
58
+ ```javascript
62
59
  var query = {
63
60
  difficulty: "medium",
64
- count: 5
65
- };
66
-
67
- api.execute(query, function (error, data) {
68
- if (error) {
69
- return console.error(error);
70
- } else {
71
- console.log(data);
72
- }
73
- });
74
- ```
75
-
76
- ---
77
-
78
- ### Using Promises
79
-
80
- You can also use promises to make requests. The API returns a promise that you can use to handle the response.
81
-
82
- ```javascript
61
+ count: 5,
62
+ image: false
63
+ };
64
+
65
+ api.execute(query, function (error, data) {
66
+ if (error) {
67
+ return console.error(error);
68
+ } else {
69
+ console.log(data);
70
+ }
71
+ });
72
+ ```
73
+
74
+ ---
75
+
76
+ ### Using Promises
77
+
78
+ You can also use promises to make requests. The API returns a promise that you can use to handle the response.
79
+
80
+ ```javascript
83
81
  var query = {
84
82
  difficulty: "medium",
85
- count: 5
86
- };
87
-
88
- api.execute(query)
89
- .then(data => {
90
- console.log(data);
91
- })
92
- .catch(error => {
93
- console.error(error);
94
- });
95
- ```
96
-
97
- ---
98
-
99
- ### Using Async/Await
100
-
101
- You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
102
-
103
- ```javascript
104
- async function makeRequest() {
83
+ count: 5,
84
+ image: false
85
+ };
86
+
87
+ api.execute(query)
88
+ .then(data => {
89
+ console.log(data);
90
+ })
91
+ .catch(error => {
92
+ console.error(error);
93
+ });
94
+ ```
95
+
96
+ ---
97
+
98
+ ### Using Async/Await
99
+
100
+ You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
101
+
102
+ ```javascript
103
+ async function makeRequest() {
105
104
  var query = {
106
105
  difficulty: "medium",
107
- count: 5
108
- };
109
-
110
- try {
111
- const data = await api.execute(query);
112
- console.log(data);
113
- } catch (error) {
114
- console.error(error);
115
- }
116
- }
117
- ```
118
-
119
- ---
120
-
121
- ## Example Response
122
-
123
- ```json
106
+ count: 5,
107
+ image: false
108
+ };
109
+
110
+ try {
111
+ const data = await api.execute(query);
112
+ console.log(data);
113
+ } catch (error) {
114
+ console.error(error);
115
+ }
116
+ }
117
+ ```
118
+
119
+ ---
120
+
121
+ ## Example Response
122
+
123
+ ```json
124
124
  {
125
125
  "status": "ok",
126
126
  "error": null,
127
127
  "data": {
128
128
  "puzzles": [
129
129
  {
130
- "scrambled": "AFYLER",
131
- "answer": "FLAYER",
132
- "letterCount": 6,
133
- "hint": "One who strips off the skin."
130
+ "scrambled": "ISIEMM",
131
+ "answer": "IMMIES",
132
+ "letterCount": 6
134
133
  },
135
134
  {
136
- "scrambled": "PUHIRRC",
137
- "answer": "CHIRRUP",
138
- "letterCount": 7,
139
- "hint": "To quicken or animate by chirping; to cherup. To chirp. Tennyson. The criket chirrups on the hearth..."
135
+ "scrambled": "DRIGIANN",
136
+ "answer": "DRAINING",
137
+ "letterCount": 8
140
138
  },
141
139
  {
142
- "scrambled": "PAINTACO",
143
- "answer": "PACATION",
144
- "letterCount": 8,
145
- "hint": "The act of pacifying; a peacemaking. Coleridge."
140
+ "scrambled": "RDAKCE",
141
+ "answer": "ARCKED",
142
+ "letterCount": 6
146
143
  },
147
144
  {
148
- "scrambled": "OMADTSI",
149
- "answer": "MASTOID",
150
- "letterCount": 7,
151
- "hint": "(a) Resembling the nipple or the breast; -- applied specifically to a process of the temporal bone b..."
145
+ "scrambled": "ERTHASDB",
146
+ "answer": "BREADTHS",
147
+ "letterCount": 8
152
148
  },
153
149
  {
154
- "scrambled": "CRVELAA",
155
- "answer": "ACERVAL",
156
- "letterCount": 7,
157
- "hint": "Pertaining to a heap. [Obs.]"
150
+ "scrambled": "SISSNASA",
151
+ "answer": "ASSASSIN",
152
+ "letterCount": 8
158
153
  }
159
154
  ],
160
155
  "count": 5,
161
156
  "difficulty": "medium",
162
- "html": "<html><head><title>Word Scramble Puzzle</title><style>body {font-family: Arial, sans-serif; padding: 20px; max-width: 600px; margin: 0 auto;}h1 {text-align: center; color: #333;}.puzzle {background: #f5f5f5; padding: 20px; margin: 15px 0; border-radius: 10px;}.scrambled {font-size: 28px; font-weight: bold; letter-spacing: 5px; color: #2196F3; text-align: center;}.hint {font-size: 14px; color: #666; margin-top: 10px; font-style: italic;}.answer-line {margin-top: 15px; border-bottom: 2px solid #333; height: 30px;}.number {font-size: 14px; color: #999;}</style></head><body><h1>Word Scramble</h1><div class='puzzle'><div class='number'>#1 (6 letters)</div><div class='scrambled'>AFYLER</div><div class='hint'>Hint: One who strips off the skin.</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#2 (7 letters)</div><div class='scrambled'>PUHIRRC</div><div class='hint'>Hint: To quicken or animate by chirping; to cherup. To chirp. Tennyson. The criket chirrups on the hearth...</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#3 (8 letters)</div><div class='scrambled'>PAINTACO</div><div class='hint'>Hint: The act of pacifying; a peacemaking. Coleridge.</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#4 (7 letters)</div><div class='scrambled'>OMADTSI</div><div class='hint'>Hint: (a) Resembling the nipple or the breast; -- applied specifically to a process of the temporal bone b...</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#5 (7 letters)</div><div class='scrambled'>CRVELAA</div><div class='hint'>Hint: Pertaining to a heap. [Obs.]</div><div class='answer-line'></div></div></body></html>"
157
+ "html": "<html><head><title>Word Scramble Puzzle</title><style>body {font-family: Arial, sans-serif; padding: 20px; max-width: 600px; margin: 0 auto;}h1 {text-align: center; color: #333;}.puzzle {background: #f5f5f5; padding: 20px; margin: 15px 0; border-radius: 10px;}.scrambled {font-size: 28px; font-weight: bold; letter-spacing: 5px; color: #2196F3; text-align: center;}.hint {font-size: 14px; color: #666; margin-top: 10px; font-style: italic;}.answer-line {margin-top: 15px; border-bottom: 2px solid #333; height: 30px;}.number {font-size: 14px; color: #999;}</style></head><body><h1>Word Scramble</h1><div class='puzzle'><div class='number'>#1 (6 letters)</div><div class='scrambled'>ISIEMM</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#2 (8 letters)</div><div class='scrambled'>DRIGIANN</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#3 (6 letters)</div><div class='scrambled'>RDAKCE</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#4 (8 letters)</div><div class='scrambled'>ERTHASDB</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#5 (8 letters)</div><div class='scrambled'>SISSNASA</div><div class='answer-line'></div></div></body></html>",
158
+ "image": {
159
+ "imageName": "d1ae484c-e879-4a0e-95b0-bfa872fa758a_wordscramble.png",
160
+ "format": ".png",
161
+ "downloadURL": "https://storage.googleapis.com/apiverve/APIData/wordscramble/d1ae484c-e879-4a0e-95b0-bfa872fa758a_wordscramble.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766010755&Signature=A9uZl5RTt%2Bk0WWM4onUMA5OyLA4xXdvR2iar2gjYoNWpdlLgYreoRvdOSYdbKpXOUENwtFphQIS6AU5iOKeAD6zC47jFAgFPPR%2BiVJjdluhg%2B37xJXMzSaU3uaFRkO4YWu2zAgSRxPNgtMM3ahbGlU5H5Nv6GGuLBihmIPcw6IVhJXG1LBzt4Vat7FEnfU4GuwJhEcpYINhkuIPTdN7yy%2FjSeBq7ZAgvwJuzDI13Ng5mFcE4uB1qB5B9AiL%2BApnyqoAJljXJbbgzHCtwwg%2FCtTlzMa0C4Biy1ka4f%2Bjf%2Bs8c07khRku4b6MNvuMiRVhjw4tRb3D7Hui%2Bx%2FWyaoB6Pg%3D%3D",
162
+ "expires": 1766010755245
163
+ }
163
164
  }
164
- }
165
- ```
166
-
167
- ---
168
-
169
- ## Customer Support
170
-
171
- Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=readme).
172
-
173
- ---
174
-
175
- ## Updates
176
-
177
- Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
178
-
179
- ---
180
-
181
- ## Legal
182
-
183
- 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).
184
-
185
- ---
186
-
187
- ## License
188
- Licensed under the The MIT License (MIT)
189
-
190
- Copyright (&copy;) 2026 APIVerve, and EvlarSoft LLC
191
-
192
- 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:
193
-
194
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
195
-
196
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
165
+ }
166
+ ```
167
+
168
+ ---
169
+
170
+ ## Customer Support
171
+
172
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=referral&utm_content=readme).
173
+
174
+ ---
175
+
176
+ ## Updates
177
+
178
+ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
179
+
180
+ ---
181
+
182
+ ## Legal
183
+
184
+ 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=referral&utm_content=readme) and [Privacy Policy](https://apiverve.com/privacy?utm_source=npm&utm_medium=referral&utm_content=readme).
185
+
186
+ ---
187
+
188
+ ## License
189
+ Licensed under the MIT License (MIT)
190
+
191
+ Copyright (&copy;) 2026 APIVerve, and EvlarSoft LLC
192
+
193
+ 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:
194
+
195
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
196
+
197
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/index.d.ts CHANGED
@@ -1,36 +1,55 @@
1
- declare module '@apiverve/wordscramble' {
2
- export interface wordscrambleOptions {
3
- api_key: string;
4
- secure?: boolean;
5
- }
6
-
7
- export interface wordscrambleResponse {
8
- status: string;
9
- error: string | null;
10
- data: WordScrambleGeneratorData;
11
- code?: number;
12
- }
13
-
1
+ declare module '@apiverve/wordscramble' {
2
+ export interface wordscrambleOptions {
3
+ api_key: string;
4
+ secure?: boolean;
5
+ }
6
+
7
+ /**
8
+ * Describes fields the current plan does not unlock. Locked fields arrive as null
9
+ * in `data`; `locked_fields` names them, using dot paths for nested fields.
10
+ * Absent when the plan unlocks everything.
11
+ */
12
+ export interface PremiumInfo {
13
+ message: string;
14
+ upgrade_url: string;
15
+ locked_fields: string[];
16
+ }
17
+
18
+ export interface wordscrambleResponse {
19
+ status: string;
20
+ error: string | null;
21
+ data: WordScrambleGeneratorData;
22
+ code?: number;
23
+ premium?: PremiumInfo;
24
+ }
25
+
14
26
 
15
27
  interface WordScrambleGeneratorData {
16
28
  puzzles: Puzzle[];
17
- count: number;
18
- difficulty: string;
19
- html: string;
29
+ count: number | null;
30
+ difficulty: null | string;
31
+ html: null | string;
32
+ image: Image;
33
+ }
34
+
35
+ interface Image {
36
+ imageName: null | string;
37
+ format: null | string;
38
+ downloadURL: null | string;
39
+ expires: number | null;
20
40
  }
21
41
 
22
42
  interface Puzzle {
23
- scrambled: string;
24
- answer: string;
25
- letterCount: number;
26
- hint: string;
43
+ scrambled: null | string;
44
+ answer: null | string;
45
+ letterCount: number | null;
27
46
  }
28
47
 
29
- export default class wordscrambleWrapper {
30
- constructor(options: wordscrambleOptions);
31
-
32
- execute(callback: (error: any, data: wordscrambleResponse | null) => void): Promise<wordscrambleResponse>;
33
- execute(query: Record<string, any>, callback: (error: any, data: wordscrambleResponse | null) => void): Promise<wordscrambleResponse>;
34
- execute(query?: Record<string, any>): Promise<wordscrambleResponse>;
35
- }
36
- }
48
+ export default class wordscrambleWrapper {
49
+ constructor(options: wordscrambleOptions);
50
+
51
+ execute(callback: (error: any, data: wordscrambleResponse | null) => void): Promise<wordscrambleResponse>;
52
+ execute(query: Record<string, any>, callback: (error: any, data: wordscrambleResponse | null) => void): Promise<wordscrambleResponse>;
53
+ execute(query?: Record<string, any>): Promise<wordscrambleResponse>;
54
+ }
55
+ }
package/index.js CHANGED
@@ -1,209 +1,209 @@
1
- const axios = require('axios');
2
-
3
- class wordscrambleWrapper {
4
-
5
- constructor(options) {
6
- if (!options || typeof options !== 'object') {
7
- throw new Error('Options object must be provided. See documentation: https://docs.apiverve.com/ref/wordscramble');
8
- }
9
-
10
- const { api_key, secure = true } = options;
11
-
12
- if (!api_key || typeof api_key !== 'string') {
13
- throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
14
- }
15
-
16
- // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
17
- const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
18
- if (!apiKeyPattern.test(api_key)) {
19
- throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens and underscores. Get your API key at: https://apiverve.com');
20
- }
21
-
22
- if (typeof secure !== 'boolean') {
23
- throw new Error('Secure parameter must be a boolean value.');
24
- }
25
-
26
- this.APIKey = api_key;
27
- this.IsSecure = secure;
28
-
29
- // secure is deprecated, all requests must be made over HTTPS
30
- this.baseURL = 'https://api.apiverve.com/v1/wordscramble';
31
-
32
- // Validation rules for parameters (generated from schema)
33
- this.validationRules = {"difficulty":{"type":"string","required":false,"default":"medium"},"count":{"type":"integer","required":false,"min":1,"max":20,"default":5}};
34
- }
35
-
36
- /**
37
- * Validate query parameters against schema rules
38
- * @param {Object} query - The query parameters to validate
39
- * @throws {Error} - If validation fails
40
- */
41
- validateParams(query) {
42
- const errors = [];
43
-
44
- for (const [paramName, rules] of Object.entries(this.validationRules)) {
45
- const value = query[paramName];
46
-
47
- // Check required
48
- if (rules.required && (value === undefined || value === null || value === '')) {
49
- errors.push(`Required parameter [${paramName}] is missing.`);
50
- continue;
51
- }
52
-
53
- // Skip validation if value is not provided and not required
54
- if (value === undefined || value === null) {
55
- continue;
56
- }
57
-
58
- // Type validation
59
- if (rules.type === 'integer' || rules.type === 'number') {
60
- const numValue = Number(value);
61
- if (isNaN(numValue)) {
62
- errors.push(`Parameter [${paramName}] must be a valid ${rules.type}.`);
63
- continue;
64
- }
65
-
66
- if (rules.type === 'integer' && !Number.isInteger(numValue)) {
67
- errors.push(`Parameter [${paramName}] must be an integer.`);
68
- continue;
69
- }
70
-
71
- // Min/max validation for numbers
72
- if (rules.min !== undefined && numValue < rules.min) {
73
- errors.push(`Parameter [${paramName}] must be at least ${rules.min}.`);
74
- }
75
- if (rules.max !== undefined && numValue > rules.max) {
76
- errors.push(`Parameter [${paramName}] must be at most ${rules.max}.`);
77
- }
78
- } else if (rules.type === 'string') {
79
- if (typeof value !== 'string') {
80
- errors.push(`Parameter [${paramName}] must be a string.`);
81
- continue;
82
- }
83
-
84
- // Length validation for strings
85
- if (rules.minLength !== undefined && value.length < rules.minLength) {
86
- errors.push(`Parameter [${paramName}] must be at least ${rules.minLength} characters.`);
87
- }
88
- if (rules.maxLength !== undefined && value.length > rules.maxLength) {
89
- errors.push(`Parameter [${paramName}] must be at most ${rules.maxLength} characters.`);
90
- }
91
-
92
- // Format validation
93
- if (rules.format) {
94
- const formatPatterns = {
95
- 'email': /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
96
- 'url': /^https?:\/\/.+/i,
97
- '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}$/,
98
- 'date': /^\d{4}-\d{2}-\d{2}$/,
99
- 'hexColor': /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
100
- };
101
-
102
- if (formatPatterns[rules.format] && !formatPatterns[rules.format].test(value)) {
103
- errors.push(`Parameter [${paramName}] must be a valid ${rules.format}.`);
104
- }
105
- }
106
- } else if (rules.type === 'boolean') {
107
- if (typeof value !== 'boolean' && value !== 'true' && value !== 'false') {
108
- errors.push(`Parameter [${paramName}] must be a boolean.`);
109
- }
110
- } else if (rules.type === 'array') {
111
- if (!Array.isArray(value)) {
112
- errors.push(`Parameter [${paramName}] must be an array.`);
113
- }
114
- }
115
-
116
- // Enum validation
117
- if (rules.enum && Array.isArray(rules.enum)) {
118
- if (!rules.enum.includes(value)) {
119
- errors.push(`Parameter [${paramName}] must be one of: ${rules.enum.join(', ')}.`);
120
- }
121
- }
122
- }
123
-
124
- if (errors.length > 0) {
125
- throw new Error(`Validation failed: ${errors.join(' ')} See documentation: https://docs.apiverve.com/ref/wordscramble`);
126
- }
127
- }
128
-
129
- async execute(query, callback) {
130
- // Handle different argument patterns
131
- if(arguments.length === 0) {
132
- // execute() - no args
133
- query = {};
134
- callback = null;
135
- } else if(arguments.length === 1) {
136
- if (typeof query === 'function') {
137
- // execute(callback)
138
- callback = query;
139
- query = {};
140
- } else {
141
- // execute(query)
142
- callback = null;
143
- }
144
- } else {
145
- // execute(query, callback)
146
- if (!query || typeof query !== 'object') {
147
- throw new Error('Query parameters must be provided as an object.');
148
- }
149
- }
150
-
151
- // Validate parameters against schema rules
152
- this.validateParams(query);
153
-
154
- const method = 'GET';
155
- const url = method === 'POST' ? this.baseURL : this.constructURL(query);
156
-
157
- try {
158
- const response = await axios({
159
- method,
160
- url,
161
- headers: {
162
- 'Content-Type': 'application/json',
163
- 'x-api-key': this.APIKey,
164
- 'auth-mode': 'npm-package'
165
- },
166
- data: method === 'POST' ? query : undefined
167
- });
168
-
169
- const data = response.data;
170
- if (callback) callback(null, data);
171
- return data;
172
- } catch (error) {
173
- let apiError;
174
-
175
- if (error.response && error.response.data) {
176
- apiError = error.response.data;
177
- } else if (error.message) {
178
- apiError = { error: error.message, status: 'error' };
179
- } else {
180
- apiError = { error: 'An unknown error occurred', status: 'error' };
181
- }
182
-
183
- if (callback) {
184
- callback(apiError, null);
185
- return; // Don't throw if callback is provided
186
- }
187
-
188
- throw apiError;
189
- }
190
- }
191
-
192
- constructURL(query) {
193
- let url = this.baseURL;
194
-
195
- if(query && typeof query === 'object')
196
- {
197
- if (Object.keys(query).length > 0) {
198
- const queryString = Object.keys(query)
199
- .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(query[key])}`)
200
- .join('&');
201
- url += `?${queryString}`;
202
- }
203
- }
204
- return url;
205
- }
206
-
207
- }
208
-
209
- module.exports = wordscrambleWrapper;
1
+ const axios = require('axios');
2
+
3
+ class wordscrambleWrapper {
4
+
5
+ constructor(options) {
6
+ if (!options || typeof options !== 'object') {
7
+ throw new Error('Options object must be provided. See documentation: https://docs.apiverve.com/ref/wordscramble');
8
+ }
9
+
10
+ const { api_key, secure = true } = options;
11
+
12
+ if (!api_key || typeof api_key !== 'string') {
13
+ throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
14
+ }
15
+
16
+ // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
17
+ const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
18
+ if (!apiKeyPattern.test(api_key)) {
19
+ throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens and underscores. Get your API key at: https://apiverve.com');
20
+ }
21
+
22
+ if (typeof secure !== 'boolean') {
23
+ throw new Error('Secure parameter must be a boolean value.');
24
+ }
25
+
26
+ this.APIKey = api_key;
27
+ this.IsSecure = secure;
28
+
29
+ // secure is deprecated, all requests must be made over HTTPS
30
+ this.baseURL = 'https://api.apiverve.com/v1/wordscramble';
31
+
32
+ // Validation rules for parameters (generated from schema)
33
+ this.validationRules = {"difficulty":{"type":"string","required":false,"default":"medium"},"count":{"type":"integer","required":false,"min":1,"max":20,"default":5},"image":{"type":"boolean","required":false,"default":false}};
34
+ }
35
+
36
+ /**
37
+ * Validate query parameters against schema rules
38
+ * @param {Object} query - The query parameters to validate
39
+ * @throws {Error} - If validation fails
40
+ */
41
+ validateParams(query) {
42
+ const errors = [];
43
+
44
+ for (const [paramName, rules] of Object.entries(this.validationRules)) {
45
+ const value = query[paramName];
46
+
47
+ // Check required
48
+ if (rules.required && (value === undefined || value === null || value === '')) {
49
+ errors.push(`Required parameter [${paramName}] is missing.`);
50
+ continue;
51
+ }
52
+
53
+ // Skip validation if value is not provided and not required
54
+ if (value === undefined || value === null) {
55
+ continue;
56
+ }
57
+
58
+ // Type validation
59
+ if (rules.type === 'integer' || rules.type === 'number') {
60
+ const numValue = Number(value);
61
+ if (isNaN(numValue)) {
62
+ errors.push(`Parameter [${paramName}] must be a valid ${rules.type}.`);
63
+ continue;
64
+ }
65
+
66
+ if (rules.type === 'integer' && !Number.isInteger(numValue)) {
67
+ errors.push(`Parameter [${paramName}] must be an integer.`);
68
+ continue;
69
+ }
70
+
71
+ // Min/max validation for numbers
72
+ if (rules.min !== undefined && numValue < rules.min) {
73
+ errors.push(`Parameter [${paramName}] must be at least ${rules.min}.`);
74
+ }
75
+ if (rules.max !== undefined && numValue > rules.max) {
76
+ errors.push(`Parameter [${paramName}] must be at most ${rules.max}.`);
77
+ }
78
+ } else if (rules.type === 'string') {
79
+ if (typeof value !== 'string') {
80
+ errors.push(`Parameter [${paramName}] must be a string.`);
81
+ continue;
82
+ }
83
+
84
+ // Length validation for strings
85
+ if (rules.minLength !== undefined && value.length < rules.minLength) {
86
+ errors.push(`Parameter [${paramName}] must be at least ${rules.minLength} characters.`);
87
+ }
88
+ if (rules.maxLength !== undefined && value.length > rules.maxLength) {
89
+ errors.push(`Parameter [${paramName}] must be at most ${rules.maxLength} characters.`);
90
+ }
91
+
92
+ // Format validation
93
+ if (rules.format) {
94
+ const formatPatterns = {
95
+ 'email': /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
96
+ 'url': /^https?:\/\/.+/i,
97
+ '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}$/,
98
+ 'date': /^\d{4}-\d{2}-\d{2}$/,
99
+ 'hexColor': /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
100
+ };
101
+
102
+ if (formatPatterns[rules.format] && !formatPatterns[rules.format].test(value)) {
103
+ errors.push(`Parameter [${paramName}] must be a valid ${rules.format}.`);
104
+ }
105
+ }
106
+ } else if (rules.type === 'boolean') {
107
+ if (typeof value !== 'boolean' && value !== 'true' && value !== 'false') {
108
+ errors.push(`Parameter [${paramName}] must be a boolean.`);
109
+ }
110
+ } else if (rules.type === 'array') {
111
+ if (!Array.isArray(value)) {
112
+ errors.push(`Parameter [${paramName}] must be an array.`);
113
+ }
114
+ }
115
+
116
+ // Enum validation
117
+ if (rules.enum && Array.isArray(rules.enum)) {
118
+ if (!rules.enum.includes(value)) {
119
+ errors.push(`Parameter [${paramName}] must be one of: ${rules.enum.join(', ')}.`);
120
+ }
121
+ }
122
+ }
123
+
124
+ if (errors.length > 0) {
125
+ throw new Error(`Validation failed: ${errors.join(' ')} See documentation: https://docs.apiverve.com/ref/wordscramble`);
126
+ }
127
+ }
128
+
129
+ async execute(query, callback) {
130
+ // Handle different argument patterns
131
+ if(arguments.length === 0) {
132
+ // execute() - no args
133
+ query = {};
134
+ callback = null;
135
+ } else if(arguments.length === 1) {
136
+ if (typeof query === 'function') {
137
+ // execute(callback)
138
+ callback = query;
139
+ query = {};
140
+ } else {
141
+ // execute(query)
142
+ callback = null;
143
+ }
144
+ } else {
145
+ // execute(query, callback)
146
+ if (!query || typeof query !== 'object') {
147
+ throw new Error('Query parameters must be provided as an object.');
148
+ }
149
+ }
150
+
151
+ // Validate parameters against schema rules
152
+ this.validateParams(query);
153
+
154
+ const method = 'GET';
155
+ const url = method === 'POST' ? this.baseURL : this.constructURL(query);
156
+
157
+ try {
158
+ const response = await axios({
159
+ method,
160
+ url,
161
+ headers: {
162
+ 'Content-Type': 'application/json',
163
+ 'x-api-key': this.APIKey,
164
+ 'auth-mode': 'npm-package'
165
+ },
166
+ data: method === 'POST' ? query : undefined
167
+ });
168
+
169
+ const data = response.data;
170
+ if (callback) callback(null, data);
171
+ return data;
172
+ } catch (error) {
173
+ let apiError;
174
+
175
+ if (error.response && error.response.data) {
176
+ apiError = error.response.data;
177
+ } else if (error.message) {
178
+ apiError = { error: error.message, status: 'error' };
179
+ } else {
180
+ apiError = { error: 'An unknown error occurred', status: 'error' };
181
+ }
182
+
183
+ if (callback) {
184
+ callback(apiError, null);
185
+ return; // Don't throw if callback is provided
186
+ }
187
+
188
+ throw apiError;
189
+ }
190
+ }
191
+
192
+ constructURL(query) {
193
+ let url = this.baseURL;
194
+
195
+ if(query && typeof query === 'object')
196
+ {
197
+ if (Object.keys(query).length > 0) {
198
+ const queryString = Object.keys(query)
199
+ .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(query[key])}`)
200
+ .join('&');
201
+ url += `?${queryString}`;
202
+ }
203
+ }
204
+ return url;
205
+ }
206
+
207
+ }
208
+
209
+ module.exports = wordscrambleWrapper;
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@apiverve/wordscramble",
3
- "version": "1.1.14",
4
- "description": "Word Scramble Generator creates puzzles where players unscramble letters to form words, with optional hints from dictionary definitions.",
3
+ "version": "1.2.2",
4
+ "description": "Word Scramble Generator is a scramble word API that creates puzzles where players unscramble letters to form words, returning each scrambled sequence with its answer and letter count.",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
7
  "sideEffects": false,
8
8
  "engines": {
9
- "node": ">=14.0.0"
9
+ "node": ">=18.0.0"
10
10
  },
11
11
  "files": [
12
12
  "index.js",
@@ -23,7 +23,7 @@
23
23
  "directory": "npm"
24
24
  },
25
25
  "keywords": [
26
- ""
26
+ "word scramble generator", "scramble word api", "word scramble api", "scramble text generator", "word scramble"
27
27
  ],
28
28
  "author": {
29
29
  "name": "APIVerve",
@@ -34,15 +34,14 @@
34
34
  "bugs": {
35
35
  "url": "https://github.com/apiverve/wordscramble-api/issues"
36
36
  },
37
- "homepage": "https://apiverve.com/marketplace/wordscramble?utm_source=npm&utm_medium=homepage",
37
+ "homepage": "https://apiverve.com/marketplace/wordscramble?utm_source=npm&utm_medium=referral&utm_content=homepage",
38
38
  "devDependencies": {
39
39
  "mocha": "^11.0.1",
40
40
  "chai": "^5.1.2",
41
41
  "dotenv": "^16.4.7"
42
42
  },
43
43
  "dependencies": {
44
- "node-fetch": "^3.3.2",
45
- "promise": "^8.3.0",
46
- "axios": "1.13.2"
44
+ "axios": "1.13.2",
45
+ "form-data": "^4.0.1"
47
46
  }
48
47
  }