@dizzzmas/sst-url-shortener-sdk - npm Package Compare versions

Comparing version 0.0.1-alpha.1 to 1.0.0

CHANGELOG.md

 # Changelog
 
+## 1.0.0 (2024-10-28)
+
+Full Changelog: [v0.0.1-alpha.1...v1.0.0](https://github.com/Dizzzmas/sst-url-shortener-js-sdk/compare/v0.0.1-alpha.1...v1.0.0)
+
+### Features
+
+* **api:** update via SDK Studio ([#4](https://github.com/Dizzzmas/sst-url-shortener-js-sdk/issues/4)) ([6f568ff](https://github.com/Dizzzmas/sst-url-shortener-js-sdk/commit/6f568ff86ad4b084733c608d0eca1d9da4a56261))
+* BREAKING CHANGE: prep for v1 release ([7734bea](https://github.com/Dizzzmas/sst-url-shortener-js-sdk/commit/7734bea72813b7f9d83034fbb7f84e9221249d12))
+
 ## 0.0.1-alpha.1 (2024-10-24)
@@ -4,0 +13,0 @@

package.json

 {
   "name": "@dizzzmas/sst-url-shortener-sdk",
-  "version": "0.0.1-alpha.1",
+  "version": "1.0.0",
   "description": "The official TypeScript library for the Sst URL Shortener API",
@@ -13,3 +13,3 @@ "author": "Sst URL Shortener <[e-mail]>",
   "files": [
-    "*"
+    "**/*"
   ],
@@ -16,0 +16,0 @@ "private": false,

README.md

@@ -1,9 +0,11 @@
-# Sst URL Shortener Node API Library
+# sst-url-shortener-js-sdk
 
 [![NPM version](https://img.shields.io/npm/v/@dizzzmas/sst-url-shortener-sdk.svg)](https://npmjs.org/package/@dizzzmas/sst-url-shortener-sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@dizzzmas/sst-url-shortener-sdk)
 
-This library provides convenient access to the Sst URL Shortener REST API from server-side TypeScript or JavaScript.
+Project this SDK is for: [sst-url-shortener](https://github.com/Dizzzmas/sst-url-shortener)
 
-The REST API documentation can be found on [docs.sst-url-shortener.com](https://docs.sst-url-shortener.com). The full API of this library can be found in [api.md](api.md).
+This library provides convenient access to the SST URL Shortener REST API from server-side TypeScript or JavaScript.
 
+The full API of this library can be found in [api.md](api.md).
+
 It is generated with [Stainless](https://www.stainlessapi.com/).
@@ -25,3 +27,6 @@
 
-const client = new SstURLShortener();
+const client = new SstURLShortener({
+  baseURL: "YOUR_URL_SHORTENER_API_URL",
+  bearerToken: "your_secret"
+});
 
@@ -283,2 +288,10 @@ async function main() {
 
+- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
+- Deno v1.28.0 or higher, using `import Terminal from "npm:@terminal/sdk"`.
+- Bun 1.0 or later.
+- Cloudflare Workers.
+- Vercel Edge Runtime.
+- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
+- Nitro v2.6 or greater.
+
 Note that React Native is not supported at this time.
@@ -285,0 +298,0 @@

src/version.ts

@@ -1,1 +0,1 @@
-export const VERSION = '0.0.1-alpha.1'; // x-release-please-version
+export const VERSION = '1.0.0'; // x-release-please-version

version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "0.0.1-alpha.1";
+export declare const VERSION = "1.0.0";
 //# sourceMappingURL=version.d.ts.map

version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.0.1-alpha.1'; // x-release-please-version
+exports.VERSION = '1.0.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

429349

increased by0.21%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

302

increased by4.5%

Worsened metrics

Published versions last two months

1

decreased by-50%

No dependency changes