Initial commit

Author: vertoman

.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+# This workflow defines the automated publish process for the
+# Vertopal JavaScript Library, triggered by semantic version tags (vX.Y.Z).
+# It builds the package, publishes it to npm, and creates a corresponding
+# GitHub Release to keep the registry and repository in sync.
+
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+permissions:
+  id-token: write
+  contents: write
+
+jobs:
+  release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        with:
+          name: "Vertopal JavaScript Library ${{ github.ref_name }}"
+          prerelease: false
+
+  publish:
+    name: Publish to npm
+    runs-on: ubuntu-latest
+    needs: release
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build package
+        run: npm run build
+
+      - name: Publish to npm
+        run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+lib/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Vertopal
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

README.md

@@ -0,0 +1,74 @@
+# Vertopal-JS
+
+Vertopal-JS is a JavaScript library for easy access to the
+[Vertopal file conversion API](https://www.vertopal.com/en/developer/api).
+
+Using Vertopal-JS, you can quickly integrate support for
+converting **350+ file formats** directly into your Node.js or
+browser-based projects.
+
+## Installing Vertopal-JS
+
+Vertopal-JS is available on
+[npm](https://www.npmjs.com/package/vertopal-js) and can be installed using
+[npm](https://www.npmjs.com/):
+
+```bash
+npm install vertopal-js
+```
+
+If you're not using npm, you can also download the most recent version of
+Vertopal-JS source code as a ZIP file from the
+[release page](https://github.com/vertopal/vertopal-js/releases/latest) and
+import it manually into your project.
+
+## Using Vertopal-JS
+
+## JavaScript Usage
+
+This package includes a public default credential (app: `free`, token:
+`FREE-TOKEN`) that lets you quickly experiment without creating an account.
+This credential is intended for personal testing and evaluation and comes
+with daily rate limits. For production workloads, or if you expect to exceed
+the free limits, you should
+[obtain a private Application ID and Security Token](https://www.vertopal.com/en/account/api/app/new)
+from your Vertopal account and configure them for full access.
+
+The following code illustrates
+[GIF to APNG](https://www.vertopal.com/en/convert/gif-to-apng) conversion using
+the Vertopal JavaScript library.
+
+```javascript
+// Import Vertopal classes
+import { Credential, Converter } from 'vertopal';
+import { FileInput, FileOutput } from 'vertopal/io';
+
+// Create a client credential instance using your app ID and security token
+const app = "free";
+const token = "FREE-TOKEN";
+const credential = new Credential(app, token);
+
+/**
+ * Initialize input and output file streams
+ * 
+ * Node.js-compatible file I/O:
+ * - `FileInput` reads from a local file path (e.g., "./MickeyMouse.gif")
+ * - `FileOutput` writes to a local file path (e.g., "./MickeyMouse.apng")
+ * 
+ * Browser-compatible file I/O:
+ * - `BrowserFileInput` reads from browser sources (e.g., <input type="file"> or drag-and-drop)
+ * - `BrowserFileOutput` writes to browser sinks (e.g., triggering a download or streaming to canvas)
+ */
+const source = new FileInput("./MickeyMouse.gif");
+const sink = new FileOutput("./MickeyMouse.apng");
+
+// Convert and download your file using the Converter class
+(async () => {
+  const converter = new Converter(credential);
+  const conversion = await converter.convert(source, sink, "apng");
+  await conversion.wait();
+  if (conversion.successful()) {
+    await conversion.download();
+  }
+})();
+```

eslint.config.mjs

@@ -0,0 +1,22 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+    plugins: { js },
+    extends: ["js/recommended"],
+    languageOptions: {
+      globals: { ...globals.browser, ...globals.node },
+    },
+  },
+  {
+    extends: [tseslint.configs.recommended],
+    files: ["**/*.{ts,tsx,mts,cts}"],
+    rules: {
+      "@typescript-eslint/no-explicit-any": "warn",
+    },
+  },
+]);