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

Comparing version 1.1.0 to 1.2.0

dist/resources/ShapeDiverArSceneApi.d.ts

@@ -5,2 +5,8 @@ import { BaseResourceApi, ShapeDiverSdkApi } from "@shapediver/sdk.geometry-api-sdk-core";
     /**
+     * Checks the existence of the specific AR scene.
+     * @param sceneId
+     * @returns `true` when the AR scene exists, otherwise `false`.
+     */
+    exists(sceneId: string): Promise<boolean>;
+    /**
      * Download the glTF file of the specified AR scene.
@@ -7,0 +13,0 @@ *

dist/resources/ShapeDiverArSceneApi.js

@@ -20,2 +20,24 @@ "use strict";
     /**
+     * Checks the existence of the specific AR scene.
+     * @param sceneId
+     * @returns `true` when the AR scene exists, otherwise `false`.
+     */
+    exists(sceneId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield (0, utils_1.sendRequest)(() => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const [_, status] = yield this.api.head(`${this.buildArSceneUri()}/${sceneId}`, { disableAuthorization: true });
+                    return status === 200;
+                }
+                catch (e) {
+                    // A 404 HTTP status is returned when the AR scene was not found.
+                    if (e instanceof sdk_geometry_api_sdk_core_1.ShapeDiverResponseError && e.status === 404)
+                        return false;
+                    else
+                        throw e;
+                }
+            }));
+        });
+    }
+    /**
      * Download the glTF file of the specified AR scene.
@@ -22,0 +44,0 @@ *

dist/resources/ShapeDiverModelApi.d.ts

@@ -85,20 +85,32 @@ import { ShapeDiverRequestConfigure, ShapeDiverRequestCustomization, ShapeDiverRequestModel, ShapeDiverRequestModelComputationQueryOrder, ShapeDiverRequestModelComputationQueryStatus, ShapeDiverRequestModelComputationQueryType, ShapeDiverRequestParameterDefinition, ShapeDiverResponseDto } from "@shapediver/api.geometry-api-dto-v2";
     /**
-     * Delete old export components.
+     * Delete all export components that have been last used at or before {@link untilLastSeen} timestamp.
      *
      * @param modelId
-     * @param untilLastSeen - Delete all components that have been used last before this timestamp.
+     * @param untilLastSeen - Timestamp, inclusive limit.
+     * Allowed Patterns: YYYY, YYYYMM, YYYYMMDD, YYYYMMDDhh, YYYYMMDDhhmm, YYYYMMDDhhmmss, YYYYMMDDhhmmssSSS
+     * @example
+     * untilLastSeen = "20221104112923123"
+     * represents the date-time "2022-11-04T11:29:23.123"
      */
     enqueueCleanupExports(modelId: string, untilLastSeen: string): Promise<ShapeDiverResponseDto>;
     /**
-     * Delete old output components.
+     * Delete all output components that have been last used at or before {@link untilLastSeen} timestamp.
      *
      * @param modelId
-     * @param untilLastSeen - Delete all components that have been used last before this timestamp.
+     * @param untilLastSeen - Timestamp, inclusive limit.
+     * Allowed Patterns: YYYY, YYYYMM, YYYYMMDD, YYYYMMDDhh, YYYYMMDDhhmm, YYYYMMDDhhmmss, YYYYMMDDhhmmssSSS
+     * @example
+     * untilLastSeen = "20221104112923123"
+     * represents the date-time "2022-11-04T11:29:23.123"
      */
     enqueueCleanupOutputs(modelId: string, untilLastSeen: string): Promise<ShapeDiverResponseDto>;
     /**
-     * Delete old texture components.
+     * Delete all texture components that have been last used at or before {@link untilLastSeen} timestamp.
      *
      * @param modelId
-     * @param untilLastSeen - Delete all components that have been used last before this timestamp.
+     * @param untilLastSeen - Timestamp, inclusive limit.
+     * Allowed Patterns: YYYY, YYYYMM, YYYYMMDD, YYYYMMDDhh, YYYYMMDDhhmm, YYYYMMDDhhmmss, YYYYMMDDhhmmssSSS
+     * @example
+     * untilLastSeen = "20221104112923123"
+     * represents the date-time "2022-11-04T11:29:23.123"
      */
@@ -105,0 +117,0 @@ enqueueCleanupTextures(modelId: string, untilLastSeen: string): Promise<ShapeDiverResponseDto>;

dist/resources/ShapeDiverModelApi.js

@@ -163,6 +163,10 @@ "use strict";
     /**
-     * Delete old export components.
+     * Delete all export components that have been last used at or before {@link untilLastSeen} timestamp.
      *
      * @param modelId
-     * @param untilLastSeen - Delete all components that have been used last before this timestamp.
+     * @param untilLastSeen - Timestamp, inclusive limit.
+     * Allowed Patterns: YYYY, YYYYMM, YYYYMMDD, YYYYMMDDhh, YYYYMMDDhhmm, YYYYMMDDhhmmss, YYYYMMDDhhmmssSSS
+     * @example
+     * untilLastSeen = "20221104112923123"
+     * represents the date-time "2022-11-04T11:29:23.123"
      */
@@ -175,6 +179,10 @@ enqueueCleanupExports(modelId, untilLastSeen) {
     /**
-     * Delete old output components.
+     * Delete all output components that have been last used at or before {@link untilLastSeen} timestamp.
      *
      * @param modelId
-     * @param untilLastSeen - Delete all components that have been used last before this timestamp.
+     * @param untilLastSeen - Timestamp, inclusive limit.
+     * Allowed Patterns: YYYY, YYYYMM, YYYYMMDD, YYYYMMDDhh, YYYYMMDDhhmm, YYYYMMDDhhmmss, YYYYMMDDhhmmssSSS
+     * @example
+     * untilLastSeen = "20221104112923123"
+     * represents the date-time "2022-11-04T11:29:23.123"
      */
@@ -187,6 +195,10 @@ enqueueCleanupOutputs(modelId, untilLastSeen) {
     /**
-     * Delete old texture components.
+     * Delete all texture components that have been last used at or before {@link untilLastSeen} timestamp.
      *
      * @param modelId
-     * @param untilLastSeen - Delete all components that have been used last before this timestamp.
+     * @param untilLastSeen - Timestamp, inclusive limit.
+     * Allowed Patterns: YYYY, YYYYMM, YYYYMMDD, YYYYMMDDhh, YYYYMMDDhhmm, YYYYMMDDhhmmss, YYYYMMDDhhmmssSSS
+     * @example
+     * untilLastSeen = "20221104112923123"
+     * represents the date-time "2022-11-04T11:29:23.123"
      */
@@ -193,0 +205,0 @@ enqueueCleanupTextures(modelId, untilLastSeen) {

dist/resources/ShapeDiverUtilsApi.d.ts

 import { ShapeDiverRequestCustomization, ShapeDiverRequestExport, ShapeDiverResponseDto } from "@shapediver/api.geometry-api-dto-v2";
 import { BaseResourceApi, ShapeDiverSdkApi, ShapeDiverSdkApiResponseType } from "@shapediver/sdk.geometry-api-sdk-core";
 import { ShapeDiverSdk } from "../ShapeDiverSdk";
+type ShapeDiverSdkUtilsDownloadType<T extends ShapeDiverSdkApiResponseType> = T extends ShapeDiverSdkApiResponseType.TEXT ? string : T extends ShapeDiverSdkApiResponseType.JSON ? Record<string, any> : T extends ShapeDiverSdkApiResponseType.DATA ? ArrayBuffer : never;
 export declare class ShapeDiverUtilsApi extends BaseResourceApi {
@@ -19,4 +20,8 @@ constructor(api: ShapeDiverSdkApi);
      * @param responseType - Indicates the type of data that the server should respond with if possible.
+     * @returns Array of size 2: [0] = response headers, [1] = response data
      */
-    download(url: string, responseType: ShapeDiverSdkApiResponseType): Promise<any>;
+    download<T extends ShapeDiverSdkApiResponseType>(url: string, responseType: T): Promise<[
+        Record<string, any>,
+        ShapeDiverSdkUtilsDownloadType<T>
+    ]>;
     /**
@@ -81,2 +86,3 @@ * Submit a customization request and wait for the result to be finished.
 }
+export {};
 //# sourceMappingURL=ShapeDiverUtilsApi.d.ts.map

dist/resources/ShapeDiverUtilsApi.js

@@ -43,2 +43,3 @@ "use strict";
      * @param responseType - Indicates the type of data that the server should respond with if possible.
+     * @returns Array of size 2: [0] = response headers, [1] = response data
      */
@@ -45,0 +46,0 @@ download(url, responseType) {

package.json

 {
   "name": "@shapediver/sdk.geometry-api-sdk-v2",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "SDK to communicate with the Geometry API version 2",
@@ -46,13 +46,13 @@ "keywords": [
   "devDependencies": {
-    "jest": "^29.0.3",
+    "jest": "^29.3.1",
     "lerna": "3.22.1",
-    "typescript": "^4.8.3",
-    "webpack": "^5.74.0",
-    "webpack-cli": "^4.10.0",
+    "typescript": "^4.9.3",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^5.0.0",
     "webpack-dev-server": "^4.11.1"
   },
   "dependencies": {
-    "@shapediver/sdk.geometry-api-sdk-core": "^1.1.0",
-    "@shapediver/api.geometry-api-dto-v2": "^1.2.0"
+    "@shapediver/sdk.geometry-api-sdk-core": "^1.2.0",
+    "@shapediver/api.geometry-api-dto-v2": "^1.3.2"
   }
 }

No alert changes

Improved metrics

Total package byte prevSize

133436

increased by3.13%

Lines of code

1897

increased by3.21%

Dependency changes

• Updated@shapediver/api.geometry-api-dto-v2@^1.3.2

• Updated@shapediver/sdk.geometry-api-sdk-core@^1.2.0