@shapediver/sdk.geometry-api-sdk-v2 - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

dist/configuration.d.ts

@@ -5,5 +5,5 @@ import { Configuration as ClientConfig, ConfigurationParameters as ClientConfigParams } from './client/configuration';
 export declare class Configuration extends ClientConfig {
-    protected readonly sdkVersion = "2.0.0";
+    protected readonly sdkVersion = "2.0.1";
     constructor(param?: ConfigurationParameters);
 }
 //# sourceMappingURL=configuration.d.ts.map

dist/configuration.js

@@ -9,3 +9,3 @@ "use strict";
         super(param);
-        this.sdkVersion = '2.0.0';
+        this.sdkVersion = '2.0.1';
         this.baseOptions = (_a = this.baseOptions) !== null && _a !== void 0 ? _a : {};
@@ -12,0 +12,0 @@ this.baseOptions.headers = (_b = this.baseOptions.headers) !== null && _b !== void 0 ? _b : {};

dist/UtilsApi.js

@@ -55,3 +55,3 @@ "use strict";
     download(url, options) {
-        const request = this.buildRequest('GET', url, options)();
+        const request = this.buildRequest('GET', url, undefined, options)();
         return request();
@@ -58,0 +58,0 @@ }

package.json

 {
     "name": "@shapediver/sdk.geometry-api-sdk-v2",
-    "version": "2.0.0",
+    "version": "2.0.1",
     "description": "SDK to communicate with the Geometry API version 2",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -9,3 +9,3 @@ <p align="center">
 
-> :warning: **You might be looking for the [v1 docs](https://github.com/shapediver/GeometryBackendSdkTypeScript/tree/legacy/v1) - [Migration Guide](https://help.shapediver.com/doc/geometry-backend-sdk-typescript-migration-guide#GeometryBackendSDKTypeScript-MigrationGuide-MigratingfromVersion1.x.xto2.x.x(03/11/2024)).**
+> :warning: **You might be looking for the [v1 docs](https://github.com/shapediver/GeometryBackendSdkTypeScript/tree/legacy/v1) - [Migration Guide](<https://help.shapediver.com/doc/geometry-backend-sdk-typescript-migration-guide#GeometryBackendSDKTypeScript-MigrationGuide-MigratingfromVersion1.x.xto2.x.x(03/11/2024)>).**
 
@@ -49,3 +49,6 @@ [ShapeDiver](https://www.shapediver.com/) is a cloud platform for building online applications
 ```typescript
-import { Configuration, SessionApi } from '@shapediver/sdk.geometry-api-sdk-v2';
+import {
+  Configuration,
+  SessionApi
+} from '@shapediver/sdk.geometry-api-sdk-v2';
 
@@ -57,6 +60,10 @@ (async function () {
     // Initialize the SDK configuration instance by providing the base URL
-    const config = new Configuration({ basePath: 'https://sdeuc1.eu-central-1.shapediver.com' });
+    const config = new Configuration({
+      basePath: 'https://sdeuc1.eu-central-1.shapediver.com'
+    });
 
     // Initialize a new session using the ticket.
-    const res = (await new SessionApi(config).createSessionByTicket(ticket)).data;
+    const res = (
+      await new SessionApi(config).createSessionByTicket(ticket)
+    ).data;
 
@@ -75,3 +82,6 @@ console.log(res);
 ```typescript
-import { Configuration, SessionApi } from '@shapediver/sdk.geometry-api-sdk-v2';
+import {
+  Configuration,
+  SessionApi
+} from '@shapediver/sdk.geometry-api-sdk-v2';
 
@@ -90,3 +100,5 @@ (async function () {
     // Initialize a new session using the ticket.
-    const res = (await new SessionApi(config).createSessionByTicket(ticket)).data;
+    const res = (
+      await new SessionApi(config).createSessionByTicket(ticket)
+    ).data;
 
@@ -134,5 +146,18 @@ console.log(res);
 
-Examples on how to interact with available endpoints are given in the
-[tests](https://github.com/shapediver/GeometryBackendSdkTypeScript/tree/master/packages/sdk.geometry-api-sdk-v2/__tests__) folder.
+- For examples of interacting with SDK endpoints, refer to the [tests
+    directory](https://github.com/shapediver/GeometryBackendSdkTypeScript/tree/master/packages/sdk.geometry-api-sdk-v2/__tests__),
+    which provides detailed usage scenarios for each endpoint.
 
+- [ShapeDiver CAD to sdTF and sdTF to glTF
+    Conversion](https://github.com/shapediver/TypeScriptSdkExample-sdTF-in-out): An example of using
+    the ShapeDiver backend to convert _CAD files to sdTF_ and _sdTF files to glTF_.
+
+- [ShapeDiver CAD to glTF
+    Conversion](https://github.com/shapediver/TypeScriptSdkExample-glTF-Converter): An example of
+    using the ShapeDiver backend to convert _CAD files to glTF format_.
+
+- [Command-Line Interface Example](https://github.com/shapediver/TypeScriptSdkExample-CLI): A simple
+    example demonstrating how to use the ShapeDiver TypeScript SDKs (_Platform SDK_ and _Geometry
+    Backend SDK_) within a CLI tool.
+
 ## Making Changes & Contributing
@@ -139,0 +164,0 @@

src/configuration.ts

@@ -9,3 +9,3 @@ import {
 export class Configuration extends ClientConfig {
-    protected readonly sdkVersion = '2.0.0'; // WARNING: This value is updated automatically!
+    protected readonly sdkVersion = '2.0.1'; // WARNING: This value is updated automatically!
 
@@ -12,0 +12,0 @@ constructor(param: ConfigurationParameters = {}) {

src/UtilsApi.ts

@@ -105,3 +105,3 @@ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
     public download(url: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {
-        const request = this.buildRequest('GET', url, options)();
+        const request = this.buildRequest('GET', url, undefined, options)();
         return request();
@@ -108,0 +108,0 @@ }

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1223094

increased by0.07%

Number of lines in readme file

232

increased by12.08%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes