@short.io/client-node 1.1.0 → 2.0.0

package/README.md

@@ -1,6 +1,7 @@
 # Short.io Node.js SDK
 
 The Short.io Node.js official SDK client is a library that allows you to integrate [short.io](https://short.io) URL shortening and link management API with your Node.js application in an easy and elegant way.
+This SDK contains methods for working with links and domains.
 
 ## API reference
 
@@ -8,7 +9,7 @@ See the [API docs](https://developers.short.io/reference) for more information.
 
 ## Installing
 
-To install this package, type:
+To install the SDK, run:
 
 ```sh
 npm i @short.io/client-node
@@ -17,59 +18,48 @@ npm i @short.io/client-node
 ## Getting Started
 
 First you need to get your API key from the Short.io dashboard in the [Integrations & API](https://app.short.io/settings/integrations/api-key) section.
-This SDK contains methods for working with links, domains and statistics. Import the Shortio class:
+Then you need to set the configuration for the client:
 
 ```js
-import { Shortio } from "shortio";
-```
-
-## Usage
-
-Then create an instance of the Shortio class, and pass your API key as the first parameter:
+import { client } from "@short.io/client-node";
 
-```js
-const shortio = new Shortio("YOUR_API_KEY");
+client.setConfig({
+    baseUrl: "https://api.short.io",
+    headers: {
+        Authorization: "YOUR_API_KEY",
+    },
+});
 ```
 
-To get the domain list, you can use the following code:
-
-```js
-const domains = await shortio.domain.list();
-```
+## Usage
 
-Get the link list of the first domain above:
+Import the needed methods from the SDK and use them in your code:
 
 ```js
-const links = await shortio.link.list(domains[0].id);
+import {
+    client,
+    getApiDomains,
+    getLinksExpand,
+    // and other needed methods
+} from "@short.io/client-node";
 ```
 
-Get the link statistics of the first link above:
+Pass created client to the methods:
 
 ```js
-const stats = await shortio.statistics.getByLink(links[0].idString);
+const domainsResp = await getApiDomains({ client });
 ```
 
-Create links:
+`domainsResp.data` will contain the list of domains.
 
 ```js
-const link = await shortio.link.create({
-  domain: "link.example.com",
-  path: "example",
-  originalURL: "https://example.com",
+const linkResp = await getLinksExpand({
+    client,
+    query: {
+        domain: "your_domain.com",
+        path: "lnk_abc123_abcde12345,
+    },
 });
-console.log(link.shortURL); // https://link.example.com/example
-
-const publicLink = await shortio.link.createPublic({
-  domain: "link.example.com",
-  originalURL: "https://example.com",
-  publicAPIKey: "PUBLIC_API_KEY",
-});
-console.log(publicLink.shortURL); // https://link.example.com/a83t48
+```
 
-const secureLink = await shortio.link.createSecure({
-  domain: "link.example.com",
-  publicAPIKey: "PUBLIC_API_KEY",
-  originalURL: "https://example.com",
-});
-console.log(secureLink.shortURL); // https://link.example.com/a83t48#ta95me8
-```
+`linkResp.data` will contain the expanded link.

package/package.json

@@ -1,16 +1,15 @@
 {
     "name": "@short.io/client-node",
-    "version": "1.1.0",
+    "version": "2.0.0",
     "description": "",
     "main": "dist/index.js",
     "type": "module",
     "private": false,
     "types": "dist/index.d.ts",
     "scripts": {
-        "compile": "tsc",
-        "format": "eslint --cache --ext .ts . && prettier --write \"src/**/*.ts\"",
-        "prepare": "npm run compile",
-        "prepublishOnly": "npm run format"
+        "generate": "node --experimental-strip-types openapi/fetch.ts && openapi-ts -f openapi/config.ts",
+        "compile": "tsc && tsc-alias",
+        "prepare": "npm run compile"
     },
     "repository": {
         "type": "git",
@@ -18,7 +17,10 @@
     },
     "keywords": [
         "short.io",
-        "api"
+        "api",
+        "client",
+        "node",
+        "sdk"
     ],
     "author": "",
     "license": "ISC",
@@ -28,9 +30,17 @@
     "homepage": "https://github.com/Short-io/client-node#readme",
     "prettier": "@short.io/eslint-config/prettier",
     "devDependencies": {
-        "@short.io/eslint-config": "npm:@short.io/style-guide@^1.5.0",
-        "@types/node": "^18.14.0",
-        "eslint": "^8.34.0",
-        "typescript": "^5.0.0"
-    }
+        "@eslint/js": "^9.16.0",
+        "@hey-api/openapi-ts": "^0.58.0",
+        "@types/node": "^22.10.1",
+        "eslint": "^9.16.0",
+        "globals": "^15.13.0",
+        "tsc-alias": "^1.8.10",
+        "typescript": "^5.7.2",
+        "typescript-eslint": "^8.17.0"
+    },
+    "dependencies": {
+        "@hey-api/client-fetch": "^0.5.0"
+    },
+    "packageManager": "yarn@1.22.22+sha256.c17d3797fb9a9115bf375e31bfd30058cac6bc9c3b8807a3d8cb2094794b51ca"
 }