@shapediver/api.geometry-api-dto-v1 - npm Package Compare versions

Comparing version 1.1.6 to 1.1.7

dist/index.js

 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
@@ -6,0 +10,0 @@ if (k2 === undefined) k2 = k;

dist/request/SdRequestDto.d.ts

@@ -0,1 +1,2 @@
+/** Type of a ticket */
 export declare enum ShapeDiverRequestTicketType {
@@ -5,10 +6,18 @@ BACKEND = "backend",
 }
+/** Body of a ticket request */
 export interface ShapeDiverRequestTicket {
+    /** which type should the ticket */
     type: ShapeDiverRequestTicketType;
+    /** timestamp until which the ticket should be valid, must be 14 characters long, format YYYYMMDDhhmmss */
     until: string;
+    /** list of domains (origins) this ticket should be limited to, may be empty */
     accessdomains?: string[];
+    /** Should this ticket allow public access (ignore accessdomains)? */
     pub: boolean;
+    /** Should this ticket provide access to model authoring (change configuration)? */
     author?: boolean;
+    /** Does this ticket identify the model via its secondary id? */
     use_id2?: boolean;
 }
+/** Data of single model parameter of a model statistics request */
 export interface ShapeDiverRequestModelStatisticsPart {
@@ -20,8 +29,11 @@ "modelid": string | string[];
 }
+/** Body of a model statistics request */
 export declare type ShapeDiverRequestModelStatistics = {
     "parameters": ShapeDiverRequestModelStatisticsPart[];
 };
+/** Body of an configure request */
 export declare type ShapeDiverRequestConfigure = {
     [key: string]: any;
 };
+/** log message level for log requests */
 export declare enum ShapeDiverRequestLogMessageLevel {
@@ -32,2 +44,3 @@ INFO = 0,
 }
+/** Body of a log message request */
 export interface ShapeDiverRequestLogMessage {
@@ -37,2 +50,3 @@ level: ShapeDiverRequestLogMessageLevel;
 }
+/** Query values of a gltf upload request */
 export declare enum ShapeDiverRequestGltfUploadQueryConversion {
@@ -39,0 +53,0 @@ NONE = "none",

dist/request/SdRequestDto.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShapeDiverRequestGltfUploadQueryConversion = exports.ShapeDiverRequestLogMessageLevel = exports.ShapeDiverRequestTicketType = void 0;
+/** Type of a ticket */
 var ShapeDiverRequestTicketType;
@@ -9,2 +10,3 @@ (function (ShapeDiverRequestTicketType) {
 })(ShapeDiverRequestTicketType = exports.ShapeDiverRequestTicketType || (exports.ShapeDiverRequestTicketType = {}));
+/** log message level for log requests */
 var ShapeDiverRequestLogMessageLevel;
@@ -16,2 +18,3 @@ (function (ShapeDiverRequestLogMessageLevel) {
 })(ShapeDiverRequestLogMessageLevel = exports.ShapeDiverRequestLogMessageLevel || (exports.ShapeDiverRequestLogMessageLevel = {}));
+/** Query values of a gltf upload request */
 var ShapeDiverRequestGltfUploadQueryConversion;
@@ -18,0 +21,0 @@ (function (ShapeDiverRequestGltfUploadQueryConversion) {

dist/request/SdRequestDtoExportOutput.d.ts

@@ -0,11 +1,41 @@
+/**
+ * Body of a customization request.
+ *
+ * @example
+ * {
+ *     <parameter id> : <basic parameter>,
+ *     <parameter id> : <s-type parameter>
+ * }
+ */
 export declare type ShapeDiverRequestCustomization = {
     [key: string]: ShapeDiverRequestParameterBasic | ShapeDiverRequestParameterSType;
 };
+/**
+ * Definition of a basic Shape Diver parameter.
+ *
+ * @example
+ * "0014bb77-e57c-4be3-92eb-24b59c41ee43" // File
+ * "0x11223344" // Color
+ * "0001-01-01T23:55:00" // Time
+ */
 export declare type ShapeDiverRequestParameterBasic = string | number | boolean;
+/** Definition of a Shape Diver s-type parameter */
 export interface ShapeDiverRequestParameterSType {
+    /**
+     * Optional embedded value.
+     * If this is set the asset is ignored
+     */
     value?: string;
+    /** Reference to the asset to be used */
     asset?: {
+        /** String id of the asset */
         id: string;
+        /**
+         * Describing which chunk to use, instead of the default one, which
+         * would get chosen based on parameter id and name.
+         */
         chunk?: {
+            /** Id of the chunk to be used */
             id?: string;
+            /** Name attribute of the chunk to be used */
             name?: string;
@@ -15,2 +45,3 @@ };
 }
+/** Body of an export request */
 export interface ShapeDiverRequestExport {
@@ -23,5 +54,14 @@ parameters: ShapeDiverRequestCustomization;
 }
+/**
+ * Body of an export or output cache request.
+ *
+ * @example
+ * {
+ *   <export or output id> : <version id>
+ * }
+ */
 export declare type ShapeDiverRequestCache = {
     [key: string]: string;
 };
+/** Definition of an export parameter */
 export declare type ShapeDiverRequestExportDefinition = {
@@ -32,8 +72,13 @@ [exportId: string]: ShapeDiverRequestExportDefinitionPart;
     [exportId: string]: {
+        /** Parameter name to display instead of name */
         displayname?: string;
+        /** Controls whether the parameter should be hidden in the UI */
         hidden?: boolean;
+        /** Ordering of the export in client applications */
         order?: number;
+        /** Description that is shown as a tooltip in the clients */
         tooltip?: string;
     };
 };
+/** Definition of an output parameter */
 export declare type ShapeDiverRequestOutputDefinition = {
@@ -43,7 +88,11 @@ [outputId: string]: ShapeDiverRequestOutputDefinitionPart;
 export declare type ShapeDiverRequestOutputDefinitionPart = {
+    /** Parameter name to display instead of name */
     displayname?: string;
+    /** Controls whether the parameter should be hidden in the UI */
     hidden?: boolean;
+    /** Ordering of the output in client applications */
     order?: number;
+    /** Description that is shown as a tooltip in the clients */
     tooltip?: string;
 };
 //# sourceMappingURL=SdRequestDtoExportOutput.d.ts.map

dist/request/SdRequestDtoModel.d.ts

@@ -0,7 +1,16 @@
+/**
+ * Body of a template request
+ */
 export interface ShapeDiverRequestModel {
     template: ShapeDiverRequestModelTemplate;
 }
+/**
+ * Data for a template request
+ **/
 export interface ShapeDiverRequestModelTemplate {
     data: ShapeDiverRequestModelTemplateData[];
 }
+/**
+ * Properties of a model request
+ */
 export declare enum ShapeDiverRequestModelTemplateDataName {
@@ -35,2 +44,5 @@ ACCESSDOMAINS = "accessdomains",
 }
+/**
+ * data objects for a template request
+ */
 export interface ShapeDiverRequestModelTemplateData {
@@ -40,2 +52,3 @@ name: ShapeDiverRequestModelTemplateDataName;
 }
+/** supported file types for models */
 export declare enum ShapeDiverRequestModelFiletype {
@@ -46,2 +59,3 @@ UNKNOWN = "unknown",
 }
+/** level of trust granted for a model */
 export declare enum ShapeDiverRequestModelTrustlevel {
@@ -52,2 +66,3 @@ UNDEFINED = "",
 }
+/** Definition of a model parameter */
 export declare type ShapeDiverRequestParameterDefinition = {
@@ -57,7 +72,11 @@ [paramId: string]: ShapeDiverRequestParameterDefinitionPart;
 export declare type ShapeDiverRequestParameterDefinitionPart = {
+    /** Parameter name to display instead of name */
     displayname?: string;
+    /** Controls whether the parameter should be hidden in the UI */
     hidden?: boolean;
+    /** Ordering of the parameter in client applications */
     order?: number;
+    /** Description that is shown as a tooltip in the clients */
     tooltip?: string;
 };
 //# sourceMappingURL=SdRequestDtoModel.d.ts.map

dist/request/SdRequestDtoModel.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShapeDiverRequestModelTrustlevel = exports.ShapeDiverRequestModelFiletype = exports.ShapeDiverRequestModelTemplateDataName = void 0;
+/**
+ * Properties of a model request
+ */
 var ShapeDiverRequestModelTemplateDataName;
@@ -33,2 +36,3 @@ (function (ShapeDiverRequestModelTemplateDataName) {
 })(ShapeDiverRequestModelTemplateDataName = exports.ShapeDiverRequestModelTemplateDataName || (exports.ShapeDiverRequestModelTemplateDataName = {}));
+/** supported file types for models */
 var ShapeDiverRequestModelFiletype;
@@ -40,2 +44,3 @@ (function (ShapeDiverRequestModelFiletype) {
 })(ShapeDiverRequestModelFiletype = exports.ShapeDiverRequestModelFiletype || (exports.ShapeDiverRequestModelFiletype = {}));
+/** level of trust granted for a model */
 var ShapeDiverRequestModelTrustlevel;
@@ -42,0 +47,0 @@ (function (ShapeDiverRequestModelTrustlevel) {

dist/request/SdRequestDtoUpload.d.ts

@@ -0,15 +1,33 @@
+/**
+ * Body of a file upload request.
+ *
+ * @example
+ * {
+ *     <file parameter id> : ShapeDiverRequestFileUploadPart
+ * }
+ */
 export declare type ShapeDiverRequestFileUpload = {
     [paramId: string]: ShapeDiverRequestFileUploadPart;
 };
+/** Data for a single file parameter part of a file upload request */
 export interface ShapeDiverRequestFileUploadPart {
+    /** Content-Type (MIME type) of the file to be uploaded */
     format: string;
+    /** size of the file to be uploaded */
     size: number;
 }
+/** Body of a sdtf upload request */
 export declare type ShapeDiverRequestSdtfUpload = ShapeDiverRequestSdtfUploadPart[];
+/** Data for a single file parameter part of a sdtf upload request */
 export interface ShapeDiverRequestSdtfUploadPart {
+    /** encoding of the sdtf to be uploaded */
     content_encoding?: string;
+    /** size of the sdtf to be uploaded */
     content_length: number;
+    /** content-type of the sdtf to be uploaded */
     content_type: ShapeDiverRequestSdtfUploadPartType;
+    /** namespace the asset shall be created in */
     namespace: string;
 }
+/** Content-Type (MIME type) of the sdtf to be uploaded */
 export declare enum ShapeDiverRequestSdtfUploadPartType {
@@ -16,0 +34,0 @@ MODEL_SDTF = "model/vnd.sdtf"

dist/request/SdRequestDtoUpload.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShapeDiverRequestSdtfUploadPartType = void 0;
+/** Content-Type (MIME type) of the sdtf to be uploaded */
 var ShapeDiverRequestSdtfUploadPartType;
@@ -5,0 +6,0 @@ (function (ShapeDiverRequestSdtfUploadPartType) {

dist/response/SdResponseDto.d.ts

@@ -5,61 +5,159 @@ import { ShapeDiverResponseExport, ShapeDiverResponseExportDefinition } from "./SdResponseDtoExport";
 import { ShapeDiverResponseOutput, ShapeDiverResponseOutputDefinition } from "./SdResponseDtoOutput";
+/**
+ * ShapeDiver API response
+ */
 export declare type ShapeDiverResponseDto = ShapeDiverResponseBase | ShapeDiverModelConfig | ShapeDiverResponseModelStatistics;
 export interface ShapeDiverResponseBase {
+    /**
+     * Version of the response format
+     */
     version: string;
+    /**
+     * Contains urgent information about the system
+     */
     message?: string;
+    /**
+     * Model object
+     */
     collection?: ShapeDiverResponseCollection;
+    /** Actions the client may take */
     actions?: ShapeDiverResponseAction[];
+    /** Request templates for actions */
     templates?: ShapeDiverResponseTemplate[];
+    /**
+     * Viewer config object
+     *
+     * Does NOT need to be typed for now
+     */
     config?: object;
+    /**
+     * Name of the model
+     */
     name?: string;
+    /** Parameter definitions, not contained with every response */
     parameters?: {
         [id: string]: ShapeDiverResponseParameter;
     };
+    /**
+     * Outputs of the model for the given parameter values
+     *
+     * output definition json objects (multiple ones, one for each output), external format
+     * see https://docs.google.com/document/d/1SCm3vgm4PYs8xRjSX257UgnAR7WM7jMW2iVcktwXqAI/edit#heading=h.trmid7acsxx
+     */
     outputs?: {
         [id: string]: ShapeDiverResponseOutput | ShapeDiverResponseOutputDefinition;
     };
+    /**
+     * Exports of the model for the given parameter values
+     *
+     * export definition json objects (multiple ones, one for each export), external format
+     * see https://docs.google.com/document/d/1SCm3vgm4PYs8xRjSX257UgnAR7WM7jMW2iVcktwXqAI/edit#heading=h.9vab10d6psiy
+     */
     exports?: {
         [id: string]: ShapeDiverResponseExport | ShapeDiverResponseExportDefinition;
     };
+    /** glTF information */
     gltf?: ShapeDiverResponseGltfUpload;
+    /** Model cleanup information */
     cleanup?: ShapeDiverResponseModelCleanupProcess[];
 }
+/** Definition of a ShapeDiver model config object  */
 export declare type ShapeDiverModelConfig = object;
+/**
+ * Defines the actions to be taken on the response data
+ */
 export interface ShapeDiverResponseAction {
+    /**
+     * Name of the action, e.g. customize, close, default, etc
+     */
     name: string;
+    /**
+     * Title of the action, e.g. 'Customize model', 'Close session', etc
+     */
     title: string;
+    /**
+     * Hyperlink to make the request to
+     */
     href: string;
+    /**
+     * HTTP method to use
+     */
     method: string;
+    /**
+     * Template for the request body, references into the 'templates' array of the response
+     * e.g. 'customize-request'
+     */
     template?: string;
 }
+/**
+ * Uses parameter definition to create template for default customize request
+ */
 export interface ShapeDiverResponseTemplate {
+    /**
+     * Name of the template, e.g. 'customize-request'
+     */
     name: string;
+    /**
+     * Title of the template, e.g. 'Template for model customization request'
+     */
     title: string;
+    /**
+     * Template for the request body
+     */
     data: object;
 }
+/** definition of a parameter of a ShapeDiver Model */
 export interface ShapeDiverResponseParameter {
+    /** unique id of parameter, stays constant each time a model gets uploaded */
     id: string;
+    /** choice of parameter values for types STRINGLIST */
     choices?: string[];
+    /** number of decimal places for numeric types */
     decimalplaces?: number;
+    /** default value of parameter, stringified */
     defval: string;
+    /** optional expression to be applied to value for visualisation */
     expression?: string;
+    /** list of file formats (content types) supported, used for type FILE */
     format?: string[];
+    /** minimum value (stringified) for numeric types */
     min?: number;
+    /**
+     * maximum value (stringified) for numeric types,
+     * maximum string length for type STRING
+     * maximum file size allowed (stringified) for type FILE
+     */
     max?: number;
+    /** minimum u value for two dimensional domain parameters */
     umin?: number;
+    /** maximum u value for two dimensional domain parameters */
     umax?: number;
+    /** minimum v value for two dimensional domain parameters */
     vmin?: number;
+    /** maximum v value for two dimensional domain parameters */
     vmax?: number;
+    /** step size used for domain parameters */
     interval?: number;
+    /** name of the parameter */
     name: string;
+    /** type of parameter */
     type: string;
+    /** optional preferred visualization of parameter, used for types FILE and STRINGLIST */
     visualization?: string;
+    /** structure of a parameter */
     structure?: ShapeDiverResponseParameterStructure;
+    /** group of a parameter */
     group?: ShapeDiverResponseParameterGroup;
+    /** technical hint for the UI implementation */
     hint?: string;
+    /** ordering of the parameter in client applications */
     order?: number;
+    /** description that is shown as a tooltip in the clients */
     tooltip?: string;
+    /** parameter name to display instead of name */
     displayname?: string;
+    /** controls whether the parameter should be hidden in the UI */
     hidden: boolean;
 }
+/** Structural information of a parameter */
 export declare enum ShapeDiverResponseParameterStructure {
@@ -70,2 +168,3 @@ ITEM = "item",
 }
+/** Group information of a parameter */
 export interface ShapeDiverResponseParameterGroup {
@@ -75,4 +174,9 @@ id: string;
 }
+/**
+ * Result part for the response to an upload request for "file" parameters
+ */
 export interface ShapeDiverResponseUploadPart {
+    /** id of the file to be uploaded */
     id: string;
+    /** href the file should be uploaded to (typically a time-limited pre-signed url) */
     href: string;
@@ -84,11 +188,21 @@ }
 export declare type ShapeDiverResponseSdtfUpload = ShapeDiverResponseUploadPart[];
+/**
+ * Information about uploaded glTF object
+ */
 export interface ShapeDiverResponseGltfUpload {
+    /** The URL to download the glTF file */
     href: string;
 }
+/** Information about a model cleanup process */
 export interface ShapeDiverResponseModelCleanupProcess {
+    /** Type of the model cleanup process */
     type: ShapeDiverResponseModelCleanupProcessType;
+    /** The timestamp when the deletion job has been enqueued (format 'YYYYMMDDhhmmssZZZ') */
     timestamp_enqueued: string;
+    /** The total number of items of this type that are going to be deleted */
     total?: number;
+    /** The number of already deleted items of this type */
     deleted?: number;
 }
+/** Model cleanup process types */
 export declare enum ShapeDiverResponseModelCleanupProcessType {
@@ -95,0 +209,0 @@ DELETE_EXPORT_VERSION = "delete_export_version",

dist/response/SdResponseDto.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShapeDiverResponseModelCleanupProcessType = exports.ShapeDiverResponseParameterStructure = void 0;
+/** Structural information of a parameter */
 var ShapeDiverResponseParameterStructure;
@@ -10,2 +11,3 @@ (function (ShapeDiverResponseParameterStructure) {
 })(ShapeDiverResponseParameterStructure = exports.ShapeDiverResponseParameterStructure || (exports.ShapeDiverResponseParameterStructure = {}));
+/** Model cleanup process types */
 var ShapeDiverResponseModelCleanupProcessType;
@@ -12,0 +14,0 @@ (function (ShapeDiverResponseModelCleanupProcessType) {

dist/response/SdResponseDtoExport.d.ts

@@ -0,2 +1,4 @@
+import { ShapeDiverResponseParameterGroup } from "./SdResponseDto";
 import { ShapeDiverResponseModelComputationStatus } from "./SdResponseDtoModelComputation";
+/** types of exports */
 export declare enum ShapeDiverResponseExportDefinitionType {
@@ -8,34 +10,86 @@ UNKNOWN = "unknown",
 }
+/**
+ * export definition WITHOUT results as exposed on the API
+ */
 export interface ShapeDiverResponseExportDefinition {
+    /** id of the export, dependent on model id, and therefore changing each time a model gets uploaded */
     id: string;
+    /**
+     * constant id of the export, not dependent on model id, and therefore NOT changing each time a model gets uploaded
+     * may be undefined because this property was introduced in summer 2020 and does not exist for exports of older models
+     */
     uid?: string;
+    /** name of the export */
     name: string;
+    /** type of export */
     type: ShapeDiverResponseExportDefinitionType;
+    /** list of ids of parameters influencing this export */
     dependency: string[];
+    /** parameter group of an export */
+    group?: ShapeDiverResponseParameterGroup;
+    /** ordering of the export in client applications */
     order?: number;
+    /** description that is shown as a tooltip in the clients */
     tooltip?: string;
+    /** parameter name to display instead of name */
     displayname?: string;
+    /** controls whether the parameter should be hidden in the UI */
     hidden: boolean;
 }
+/**
+ * export definition WITH results as exposed on the API
+ */
 export interface ShapeDiverResponseExport extends ShapeDiverResponseExportDefinition {
+    /** requested version of the export */
     version?: string;
+    /** optional delay in milliseconds after which an export cache request shall be sent to check again for this export version
+     * this property is used ONLY if the export version has not been computed yet
+     */
     delay?: number;
+    /** result parts
+     * in case this array does not exist, this means that the workers have not finished computation for this output version
+     */
     content?: ShapeDiverResponseExportPart[];
+    /**
+     * In case computation of the export version (temporarily) failed:
+     * Optional message to the user, explaining what went wrong
+     */
     msg?: string;
+    /** optional suggested filename for the files to be downloaded */
     filename?: string;
+    /** optional result object for exports of type 'email' and 'shapeways' */
     result?: ShapeDiverResponseExportResult;
+    /** Status of the computation which resulted in the export version */
     status_computation?: ShapeDiverResponseModelComputationStatus;
+    /** Status of collecting results for the export version */
     status_collect?: ShapeDiverResponseModelComputationStatus;
 }
+/**
+ * An item of the "content" array for exports
+ */
 export interface ShapeDiverResponseExportPart {
+    /**
+     * format of export result (let's keep it as a string, because the backend doesn't need to know about this, just pass it through)
+     */
     format: string;
+    /**
+     * Link for download of exported sset
+     */
     href: string;
+    /** optional size of exported asset */
     size?: number;
 }
+/**
+ * optional result object for exports of type 'email' and 'shapeways'
+ */
 export interface ShapeDiverResponseExportResult {
+    /** optional success message for user */
     msg?: string;
+    /** optional error message for user */
     err?: string;
+    /** optional href to redirect user to for download */
     href?: string;
+    /** optional shapeways model id */
     modelId?: string;
 }
 //# sourceMappingURL=SdResponseDtoExport.d.ts.map

dist/response/SdResponseDtoExport.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShapeDiverResponseExportDefinitionType = void 0;
+/** types of exports */
 var ShapeDiverResponseExportDefinitionType;
@@ -5,0 +6,0 @@ (function (ShapeDiverResponseExportDefinitionType) {

dist/response/SdResponseDtoModel.d.ts

@@ -20,2 +20,3 @@ export interface ShapeDiverResponseCollection {
 }
+/** See ISdModel for definition of these properties */
 export declare enum ShapeDiverResponseCollectionItemDataName {
@@ -26,2 +27,4 @@ ACCESSDOMAINS = "accessdomains",
     BACKLINKURL = "backlinkurl",
+    /** commented on purpose, we ended up not using this property */
+    /** CALLBACK = 'callback', */
     CHECKURL = "checkurl",
@@ -57,2 +60,3 @@ COMP_TIME = "comptime",
     REQUIRE_TOKEN = "require_token",
+    /** this property does not exist in ISdModel, it is used to deliver a pre-signed url for model upload to clients */
     S3URL = "s3url",
@@ -62,2 +66,3 @@ SESSION_RATE_LIMIT = "session_rate_limit",
     STAT = "stat",
+    /** this property does not exist in ISdModel, it is used to deliver a requested ticket to clients */
     TICKET = "ticket",
@@ -64,0 +69,0 @@ TRUST = "trust",

dist/response/SdResponseDtoModel.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShapeDiverResponseCollectionItemLinkRel = exports.ShapeDiverResponseCollectionItemDataName = void 0;
+/** See ISdModel for definition of these properties */
 var ShapeDiverResponseCollectionItemDataName;
@@ -10,2 +11,4 @@ (function (ShapeDiverResponseCollectionItemDataName) {
     ShapeDiverResponseCollectionItemDataName["BACKLINKURL"] = "backlinkurl";
+    /** commented on purpose, we ended up not using this property */
+    /** CALLBACK = 'callback', */
     ShapeDiverResponseCollectionItemDataName["CHECKURL"] = "checkurl";
@@ -41,2 +44,3 @@ ShapeDiverResponseCollectionItemDataName["COMP_TIME"] = "comptime";
     ShapeDiverResponseCollectionItemDataName["REQUIRE_TOKEN"] = "require_token";
+    /** this property does not exist in ISdModel, it is used to deliver a pre-signed url for model upload to clients */
     ShapeDiverResponseCollectionItemDataName["S3URL"] = "s3url";
@@ -46,2 +50,3 @@ ShapeDiverResponseCollectionItemDataName["SESSION_RATE_LIMIT"] = "session_rate_limit";
     ShapeDiverResponseCollectionItemDataName["STAT"] = "stat";
+    /** this property does not exist in ISdModel, it is used to deliver a requested ticket to clients */
     ShapeDiverResponseCollectionItemDataName["TICKET"] = "ticket";
@@ -48,0 +53,0 @@ ShapeDiverResponseCollectionItemDataName["TRUST"] = "trust";

dist/response/SdResponseDtoModelStatistics.d.ts

@@ -0,1 +1,4 @@
+/**
+ * Model statistics components
+ */
 export declare type ShapeDiverResponseModelStatistics = ShapeDiverResponseModelStatisticsPart[];
@@ -2,0 +5,0 @@ export interface ShapeDiverResponseModelStatisticsPart {

dist/response/SdResponseDtoModelStatistics.js

 "use strict";
+/**
+ * Model statistics components
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SdResponseDtoModelStatistics.js.map

dist/response/SdResponseDtoOutput.d.ts

 import { ShapeDiverResponseModelComputationStatus } from "./SdResponseDtoModelComputation";
+/**
+ * output definition WITHOUT results as exposed on the API
+ */
 export interface ShapeDiverResponseOutputDefinition {
+    /** id of the output, dependent on model id, and therefore changing each time a model gets uploaded */
     id: string;
+    /**
+     * constant id of the output, not dependent on model id, and therefore NOT changing each time a model gets uploaded
+     * may be undefined because this property was introduced in summer 2020 and does not exist for outputs of older models
+     */
     uid?: string;
+    /** name of the output */
     name: string;
+    /** optional id of the output holding material information for this output */
     material?: string;
+    /** information about which chunks exist in the asset/sdtf */
     chunks?: ShapeDiverResponseOutputChunk[];
+    /** list of ids of parameters influencing this output */
     dependency: string[];
+    /** ordering of the output in client applications */
     order?: number;
+    /** description that is shown as a tooltip in the clients */
     tooltip?: string;
+    /** parameter name to display instead of name */
     displayname?: string;
+    /** controls whether the parameter should be hidden in the UI */
     hidden: boolean;
 }
+/**
+ * output definition WITH results as exposed on the API
+ */
 export interface ShapeDiverResponseOutput extends ShapeDiverResponseOutputDefinition {
+    /** requested version of the output */
     version: string;
+    /**
+     * optional delay in milliseconds after which a cache request shall be sent to check again for this output version
+     * this property is used ONLY if the output version has not been computed yet
+     */
     delay?: number;
+    /**
+     * result parts
+     * in case this array does not exist, this means that the workers have not finished computation for this output version
+     */
     content?: ShapeDiverResponseOutputPart[];
+    /** Optional bounding box, minimum corner  */
     bbmin?: number[];
+    /** Optional bounding box, maximum corner  */
     bbmax?: number[];
+    /**
+     * In case computation of the output version (temporarily) failed:
+     * Optional message to the user, explaining what went wrong
+     */
     msg?: string;
+    /** Status of the computation which resulted in the output version */
     status_computation?: ShapeDiverResponseModelComputationStatus;
+    /** Status of collecting results for the output version */
     status_collect?: ShapeDiverResponseModelComputationStatus;
 }
+/**
+ * An item of the "content" array of outputs
+ */
 export interface ShapeDiverResponseOutputPart {
+    /**
+     * optional link to asset
+     */
     href?: string;
+    /** size in bytes for parts of type "asset" */
     size?: number;
+    /** optionally used for type "data" */
     name?: string;
+    /** transformations to be applied in case of type "external" or "asset" */
     transformations?: number[][];
+    /**
+     * format of part, used by all types of parts
+     *   * file ending for parts of type "asset"
+     *   * "material" (data contains a material definition)
+     *   * "data" (data contains arbitrary data)
+     *   * "external" (href or (s3bucket and s3key) refer to an external asset)
+     *
+     * Alex: we might introduce an enum for this (but it's cumbersome because of the various file types we are using)
+     */
     format: string;
+    /**
+     * this was used by legacy "transform_content_array" in case of an error in getting texture urls --> review whether this still makes sense and is required
+     */
     msg?: string;
+    /** used for types "material" and "data" */
     data?: any;
+    /** optional Content-Type for parts of type "asset" */
     contentType?: string;
 }
+/** Represents a collection of nodes where to start enumerating the content of the Sdtf file (entry points) */
 export interface ShapeDiverResponseOutputChunk {
+    /** Id of the chunk */
     id: string;
+    /** Name of the chunk */
     name: string;
+    /** Indicates what type of data the data item holds */
     typeHint: string;
+    /** Description that is shown as a tooltip in the clients */
     tooltip?: string;
 }
 //# sourceMappingURL=SdResponseDtoOutput.d.ts.map

package.json

 {
   "name": "@shapediver/api.geometry-api-dto-v1",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "Data Transfer Object Definitions of the Geometry API v1",
@@ -29,4 +29,4 @@ "keywords": [],
     "lerna": "3.22.1",
-    "typescript": "^4.5.5"
+    "typescript": "^4.6.2"
   }
 }

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

Improved metrics

Total package byte prevSize

73545

increased by30.92%

Lines of code

1117

increased by48.34%

No dependency changes