@apiverve/ascii85encoder 1.1.12

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/LICENSE ADDED
@@ -0,0 +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
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,169 @@
1
+ # ASCII85 Encoder API
2
+
3
+ ASCII85 Encoder is a tool for encoding and decoding data using ASCII85 (also known as Base85) encoding. It supports both standard and btoa formats for efficient binary-to-text encoding with better compression than Base64.
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
+
9
+ This is a Javascript Wrapper for the [ASCII85 Encoder API](https://apiverve.com/marketplace/ascii85encoder)
10
+
11
+ ---
12
+
13
+ ## Installation
14
+
15
+ Using npm:
16
+ ```shell
17
+ npm install @apiverve/ascii85encoder
18
+ ```
19
+
20
+ Using yarn:
21
+ ```shell
22
+ yarn add @apiverve/ascii85encoder
23
+ ```
24
+
25
+ ---
26
+
27
+ ## Configuration
28
+
29
+ Before using the ASCII85 Encoder 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
+
32
+ ---
33
+
34
+ ## Quick Start
35
+
36
+ [Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
37
+
38
+ The ASCII85 Encoder API documentation is found here: [https://docs.apiverve.com/ref/ascii85encoder](https://docs.apiverve.com/ref/ascii85encoder).
39
+ You can find parameters, example responses, and status codes documented here.
40
+
41
+ ### Setup
42
+
43
+ ```javascript
44
+ const ascii85encoderAPI = require('@apiverve/ascii85encoder');
45
+ const api = new ascii85encoderAPI({
46
+ api_key: '[YOUR_API_KEY]'
47
+ });
48
+ ```
49
+
50
+ ---
51
+
52
+ ## Usage
53
+
54
+ ---
55
+
56
+ ### Perform Request
57
+
58
+ 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.
59
+
60
+ ```javascript
61
+ var query = {
62
+ text: "Hello World",
63
+ action: "encode",
64
+ format: "standard"
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
83
+ var query = {
84
+ text: "Hello World",
85
+ action: "encode",
86
+ format: "standard"
87
+ };
88
+
89
+ api.execute(query)
90
+ .then(data => {
91
+ console.log(data);
92
+ })
93
+ .catch(error => {
94
+ console.error(error);
95
+ });
96
+ ```
97
+
98
+ ---
99
+
100
+ ### Using Async/Await
101
+
102
+ You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
103
+
104
+ ```javascript
105
+ async function makeRequest() {
106
+ var query = {
107
+ text: "Hello World",
108
+ action: "encode",
109
+ format: "standard"
110
+ };
111
+
112
+ try {
113
+ const data = await api.execute(query);
114
+ console.log(data);
115
+ } catch (error) {
116
+ console.error(error);
117
+ }
118
+ }
119
+ ```
120
+
121
+ ---
122
+
123
+ ## Example Response
124
+
125
+ ```json
126
+ {
127
+ "status": "ok",
128
+ "error": null,
129
+ "data": {
130
+ "original_text": "Hello World",
131
+ "encoded": "87cURD]i,\"Ebo7",
132
+ "format": "standard",
133
+ "original_length": 11,
134
+ "encoded_length": 14,
135
+ "compression_ratio": "127.27%"
136
+ }
137
+ }
138
+ ```
139
+
140
+ ---
141
+
142
+ ## Customer Support
143
+
144
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
145
+
146
+ ---
147
+
148
+ ## Updates
149
+
150
+ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
151
+
152
+ ---
153
+
154
+ ## Legal
155
+
156
+ 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.
157
+
158
+ ---
159
+
160
+ ## License
161
+ Licensed under the The MIT License (MIT)
162
+
163
+ Copyright (©) 2025 APIVerve, and EvlarSoft LLC
164
+
165
+ 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:
166
+
167
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
168
+
169
+ 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.
@@ -0,0 +1,40 @@
1
+ /**
2
+ * Basic Example - ASCII85 Encoder API
3
+ *
4
+ * This example demonstrates how to use the ASCII85 Encoder 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 ascii85encoderAPI = require('../index.js');
10
+
11
+ // Initialize the API client
12
+ const api = new ascii85encoderAPI({
13
+ api_key: process.env.API_KEY || '[YOUR_API_KEY]'
14
+ });
15
+
16
+ // Example query
17
+ var query = {
18
+ text: "Hello World",
19
+ action: "encode",
20
+ format: "standard"
21
+ };
22
+
23
+ // Make the API request using callback
24
+ console.log('Making request to ASCII85 Encoder API...\n');
25
+
26
+ api.execute(query, function (error, data) {
27
+ if (error) {
28
+ console.error('Error occurred:');
29
+ if (error.error) {
30
+ console.error('Message:', error.error);
31
+ console.error('Status:', error.status);
32
+ } else {
33
+ console.error(JSON.stringify(error, null, 2));
34
+ }
35
+ return;
36
+ }
37
+
38
+ console.log('Response:');
39
+ console.log(JSON.stringify(data, null, 2));
40
+ });
package/index.d.ts ADDED
@@ -0,0 +1,31 @@
1
+ declare module '@apiverve/ascii85encoder' {
2
+ export interface ascii85encoderOptions {
3
+ api_key: string;
4
+ secure?: boolean;
5
+ }
6
+
7
+ export interface ascii85encoderResponse {
8
+ status: string;
9
+ error: string | null;
10
+ data: ASCII85EncoderData;
11
+ code?: number;
12
+ }
13
+
14
+
15
+ interface ASCII85EncoderData {
16
+ originalText: string;
17
+ encoded: string;
18
+ format: string;
19
+ originalLength: number;
20
+ encodedLength: number;
21
+ compressionRatio: string;
22
+ }
23
+
24
+ export default class ascii85encoderWrapper {
25
+ constructor(options: ascii85encoderOptions);
26
+
27
+ execute(callback: (error: any, data: ascii85encoderResponse | null) => void): Promise<ascii85encoderResponse>;
28
+ execute(query: Record<string, any>, callback: (error: any, data: ascii85encoderResponse | null) => void): Promise<ascii85encoderResponse>;
29
+ execute(query?: Record<string, any>): Promise<ascii85encoderResponse>;
30
+ }
31
+ }
package/index.js ADDED
@@ -0,0 +1,124 @@
1
+ const axios = require('axios');
2
+
3
+ class ascii85encoderWrapper {
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/ascii85encoder');
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 or alphanumeric with hyphens)
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. Get your API key at: https://apiverve.com');
20
+ }
21
+
22
+ // Check minimum length (GUIDs are typically 36 chars with hyphens, or 32 without)
23
+ const trimmedKey = api_key.replace(/-/g, '');
24
+ if (trimmedKey.length < 32) {
25
+ throw new Error('Invalid API key. API key appears to be too short. Get your API key at: https://apiverve.com');
26
+ }
27
+
28
+ if (typeof secure !== 'boolean') {
29
+ throw new Error('Secure parameter must be a boolean value.');
30
+ }
31
+
32
+ this.APIKey = api_key;
33
+ this.IsSecure = secure;
34
+
35
+ // secure is deprecated, all requests must be made over HTTPS
36
+ this.baseURL = 'https://api.apiverve.com/v1/ascii85encoder';
37
+ }
38
+
39
+ async execute(query, callback) {
40
+ // Handle different argument patterns
41
+ if(arguments.length === 0) {
42
+ // execute() - no args
43
+ query = {};
44
+ callback = null;
45
+ } else if(arguments.length === 1) {
46
+ if (typeof query === 'function') {
47
+ // execute(callback)
48
+ callback = query;
49
+ query = {};
50
+ } else {
51
+ // execute(query)
52
+ callback = null;
53
+ }
54
+ } else {
55
+ // execute(query, callback)
56
+ if (!query || typeof query !== 'object') {
57
+ throw new Error('Query parameters must be provided as an object.');
58
+ }
59
+ }
60
+
61
+ var requiredParams = ["text"];
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/ascii85encoder`);
66
+ }
67
+ }
68
+ }
69
+
70
+ const method = 'GET';
71
+ const url = method === 'POST' ? this.baseURL : this.constructURL(query);
72
+
73
+ try {
74
+ const response = await axios({
75
+ method,
76
+ url,
77
+ headers: {
78
+ 'Content-Type': 'application/json',
79
+ 'x-api-key': this.APIKey,
80
+ 'auth-mode': 'npm-package'
81
+ },
82
+ data: method === 'POST' ? query : undefined
83
+ });
84
+
85
+ const data = response.data;
86
+ if (callback) callback(null, data);
87
+ return data;
88
+ } catch (error) {
89
+ let apiError;
90
+
91
+ if (error.response && error.response.data) {
92
+ apiError = error.response.data;
93
+ } else if (error.message) {
94
+ apiError = { error: error.message, status: 'error' };
95
+ } else {
96
+ apiError = { error: 'An unknown error occurred', status: 'error' };
97
+ }
98
+
99
+ if (callback) {
100
+ callback(apiError, null);
101
+ return; // Don't throw if callback is provided
102
+ }
103
+
104
+ throw apiError;
105
+ }
106
+ }
107
+
108
+ constructURL(query) {
109
+ let url = this.baseURL;
110
+
111
+ if(query && typeof query === 'object')
112
+ {
113
+ if (Object.keys(query).length > 0) {
114
+ const queryString = Object.keys(query)
115
+ .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(query[key])}`)
116
+ .join('&');
117
+ url += `?${queryString}`;
118
+ }
119
+ }
120
+ return url;
121
+ }
122
+ }
123
+
124
+ module.exports = ascii85encoderWrapper;
package/package.json ADDED
@@ -0,0 +1,35 @@
1
+ {
2
+ "name": "@apiverve/ascii85encoder",
3
+ "version": "1.1.12",
4
+ "description": "ASCII85 Encoder is a tool for encoding and decoding data using ASCII85 (also known as Base85) encoding. It supports both standard and btoa formats for efficient binary-to-text encoding with better compression than Base64.",
5
+ "main": "index.js",
6
+ "types": "index.d.ts",
7
+ "scripts": {
8
+ "test": "mocha",
9
+ "example": "node examples/basic.js"
10
+ },
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "git+https://github.com/apiverve/ascii85encoder-api.git",
14
+ "directory": "npm"
15
+ },
16
+ "keywords": [
17
+ "ascii85", "base85", "encoding", "decoding", "data encoding"
18
+ ],
19
+ "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
20
+ "license": "MIT",
21
+ "bugs": {
22
+ "url": "https://github.com/apiverve/ascii85encoder-api/issues"
23
+ },
24
+ "homepage": "https://apiverve.com/marketplace/ascii85encoder?utm_source=npm",
25
+ "devDependencies": {
26
+ "mocha": "^11.0.1",
27
+ "chai": "^5.1.2",
28
+ "dotenv": "^16.4.7"
29
+ },
30
+ "dependencies": {
31
+ "node-fetch": "^3.3.2",
32
+ "promise": "^8.3.0",
33
+ "axios": "1.13.2"
34
+ }
35
+ }
package/tmp/build.dat ADDED
@@ -0,0 +1 @@
1
+ #