npm - cobrili-client - Versions diffs - 1.0.0 → 1.0.2 - Mend

cobrili-client 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/dist/index.d.ts CHANGED Viewed

@@ -2572,6 +2572,36 @@ declare const API_METHODS: {
             readonly type: "boolean";
         }];
         readonly responseFields: readonly [{
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "object";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "object";
+        }, {
             readonly optional?: boolean;
             readonly objectType?: string | undefined;
             readonly itemType?: FieldType;
@@ -2667,6 +2697,36 @@ declare const API_METHODS: {
             readonly defaultValue?: any;
             readonly name: string;
             readonly type: "string";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "string";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "string";
         }];
         readonly category: "Configuration";
         readonly description: "Get current Cobrili version";
@@ -2971,6 +3031,21 @@ declare const API_METHODS: {
             readonly type: "object";
         }];
         readonly responseFields: readonly [{
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "boolean";
+        }, {
             readonly optional?: boolean;
             readonly objectType?: string | undefined;
             readonly itemType?: FieldType;
@@ -3036,6 +3111,66 @@ declare const API_METHODS: {
             readonly defaultValue?: any;
             readonly name: string;
             readonly type: "boolean";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "string";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "double";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "array";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "array";
         }];
         readonly category: "Helpset Import/Export/Management";
         readonly description: "Delete a helpset";
@@ -3219,6 +3354,21 @@ declare const API_METHODS: {
             readonly defaultValue?: any;
             readonly name: string;
             readonly type: "int";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "string";
         }];
         readonly category: "Helpset Import/Export/Management";
         readonly description: "Import multiple helpsets from a folder";
@@ -3500,12 +3650,12 @@ declare const API_METHODS: {
             readonly vartype?: string;
             readonly defaultValue?: any;
             readonly name: string;
-            readonly type: "string";
+            readonly type: "int";
         }, {
             readonly optional?: boolean;
-            readonly objectType?: "SearchQueryParameters" | undefined;
+            readonly objectType?: "StartSearchRequest" | undefined;
             readonly itemType?: FieldType;
-            readonly itemObjectType?: "SearchQueryParameters" | undefined;
+            readonly itemObjectType?: "StartSearchRequest" | undefined;
             readonly keytype?: string;
             readonly xmlTag?: string;
             readonly varname?: string;
@@ -3518,9 +3668,9 @@ declare const API_METHODS: {
             readonly type: "object";
         }, {
             readonly optional?: boolean;
-            readonly objectType?: string | undefined;
+            readonly objectType?: "SearchProposalResult" | undefined;
             readonly itemType?: FieldType;
-            readonly itemObjectType?: string | undefined;
+            readonly itemObjectType?: "SearchProposalResult" | undefined;
             readonly keytype?: string;
             readonly xmlTag?: string;
             readonly varname?: string;
@@ -3530,7 +3680,7 @@ declare const API_METHODS: {
             readonly vartype?: string;
             readonly defaultValue?: any;
             readonly name: string;
-            readonly type: "int";
+            readonly type: "array";
         }];
         readonly category: "Search Extended";
         readonly description: "Get search parameters for a search ID";
@@ -4149,6 +4299,21 @@ declare const API_METHODS: {
             readonly type: "array";
         }];
         readonly responseFields: readonly [{
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "double";
+        }, {
             readonly optional?: boolean;
             readonly objectType?: "FacetChange" | undefined;
             readonly itemType?: FieldType;
@@ -4674,9 +4839,9 @@ declare const API_METHODS: {
         }];
         readonly responseFields: readonly [{
             readonly optional?: boolean;
-            readonly objectType?: string | undefined;
+            readonly objectType?: "SearchSettings" | undefined;
             readonly itemType?: FieldType;
-            readonly itemObjectType?: string | undefined;
+            readonly itemObjectType?: "SearchSettings" | undefined;
             readonly keytype?: string;
             readonly xmlTag?: string;
             readonly varname?: string;
@@ -5199,9 +5364,9 @@ declare const API_METHODS: {
         }];
         readonly responseFields: readonly [{
             readonly optional?: boolean;
-            readonly objectType?: "MetaKeyDefinition" | undefined;
+            readonly objectType?: string | undefined;
             readonly itemType?: FieldType;
-            readonly itemObjectType?: "MetaKeyDefinition" | undefined;
+            readonly itemObjectType?: string | undefined;
             readonly keytype?: string;
             readonly xmlTag?: string;
             readonly varname?: string;
@@ -5211,13 +5376,13 @@ declare const API_METHODS: {
             readonly vartype?: string;
             readonly defaultValue?: any;
             readonly name: string;
-            readonly type: "array";
+            readonly type: "map";
         }];
         readonly category: "Metadata Extended";
         readonly description: "Get allowed metadata keys for master helpset";
     };
     readonly getPossibleMetaValuesByMetaKeyID: {
-        readonly method: "GetPossibleMetaValuesByMetaKeyId";
+        readonly method: "GetPossibleMetaValuesByMetaKeyID";
         readonly requestType: "GetPossibleMetaValuesByMetaKeyIdRequest";
         readonly requestFields: readonly [{
             readonly optional?: boolean;
@@ -5383,6 +5548,21 @@ declare const API_METHODS: {
             readonly type: "boolean";
         }];
         readonly responseFields: readonly [{
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "stringArray";
+        }, {
             readonly optional?: boolean;
             readonly objectType?: "LocalizedEntry" | undefined;
             readonly itemType?: FieldType;
@@ -5570,7 +5750,7 @@ declare const API_METHODS: {
             readonly vartype?: string;
             readonly defaultValue?: any;
             readonly name: string;
-            readonly type: "object";
+            readonly type: "stringArray";
         }];
         readonly category: "Metadata Extended";
         readonly description: "Get startup meta values";
@@ -5678,7 +5858,7 @@ declare const API_METHODS: {
         readonly description: "Get navigation with metadata";
     };
     readonly getBreadCrumbWithMetaData: {
-        readonly method: "GetBreadcrumbWithMetaData";
+        readonly method: "GetBreadCrumbWithMetaData";
         readonly requestType: "GetBreadcrumbWithMetaDataRequest";
         readonly requestFields: readonly [{
             readonly optional?: boolean;
@@ -6208,7 +6388,7 @@ declare const API_METHODS: {
         readonly description: "Get navigation with metadata for language";
     };
     readonly getBreadCrumbWithMetaDataForGivenLanguage: {
-        readonly method: "GetBreadcrumbWithMetaData_ForGivenLanguage";
+        readonly method: "GetBreadCrumbWithMetaData_ForGivenLanguage";
         readonly requestType: "GetBreadcrumbWithMetaData_ForGivenLanguageRequest";
         readonly requestFields: readonly [{
             readonly optional?: boolean;
@@ -6337,6 +6517,21 @@ declare const API_METHODS: {
             readonly defaultValue?: any;
             readonly name: string;
             readonly type: "stringArray";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: "LocalizedEntry" | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: "LocalizedEntry" | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "array";
         }];
         readonly category: "Metadata Extended";
         readonly description: "Get metadata values for facets";
@@ -6390,6 +6585,21 @@ declare const API_METHODS: {
             readonly defaultValue?: any;
             readonly name: string;
             readonly type: "stringArray";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: "LocalizedEntry" | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: "LocalizedEntry" | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "array";
         }];
         readonly category: "Metadata Extended";
         readonly description: "Get metadata values for facets for language";
@@ -6466,9 +6676,9 @@ declare const API_METHODS: {
         }];
         readonly responseFields: readonly [{
             readonly optional?: boolean;
-            readonly objectType?: "MetaDataDefinition" | undefined;
+            readonly objectType?: string | undefined;
             readonly itemType?: FieldType;
-            readonly itemObjectType?: "MetaDataDefinition" | undefined;
+            readonly itemObjectType?: string | undefined;
             readonly keytype?: string;
             readonly xmlTag?: string;
             readonly varname?: string;
@@ -6478,7 +6688,7 @@ declare const API_METHODS: {
             readonly vartype?: string;
             readonly defaultValue?: any;
             readonly name: string;
-            readonly type: "array";
+            readonly type: "map";
         }];
         readonly category: "Metadata Extended";
         readonly description: "Get metadata definitions for customer criteria";
@@ -7795,9 +8005,9 @@ declare const API_METHODS: {
         }];
         readonly responseFields: readonly [{
             readonly optional?: boolean;
-            readonly objectType?: string | undefined;
+            readonly objectType?: "MetaValueForGroupRightEntry" | undefined;
             readonly itemType?: FieldType;
-            readonly itemObjectType?: string | undefined;
+            readonly itemObjectType?: "MetaValueForGroupRightEntry" | undefined;
             readonly keytype?: string;
             readonly xmlTag?: string;
             readonly varname?: string;
@@ -7807,7 +8017,7 @@ declare const API_METHODS: {
             readonly vartype?: string;
             readonly defaultValue?: any;
             readonly name: string;
-            readonly type: "object";
+            readonly type: "array";
         }];
         readonly category: "Group/Rights Management";
         readonly description: "Get group rights";
@@ -8084,6 +8294,21 @@ declare const API_METHODS: {
             readonly defaultValue?: any;
             readonly name: string;
             readonly type: "boolean";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "string";
         }];
         readonly category: "GUI/Language Extended";
         readonly description: "Check if GUI language is valid";
@@ -8208,7 +8433,52 @@ declare const API_METHODS: {
             readonly vartype?: string;
             readonly defaultValue?: any;
             readonly name: string;
-            readonly type: "object";
+            readonly type: "double";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "string";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "string";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "string";
         }];
         readonly category: "Topic/Navigation Extended";
         readonly description: "Get additional helpset info";
@@ -8489,6 +8759,21 @@ declare const API_METHODS: {
             readonly defaultValue?: any;
             readonly name: string;
             readonly type: "string";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "stringMap";
         }];
         readonly description: "Get external ID ignoring container helpsets";
     };
@@ -8801,6 +9086,21 @@ declare const API_METHODS: {
             readonly defaultValue?: any;
             readonly name: string;
             readonly type: "boolean";
+        }, {
+            readonly optional?: boolean;
+            readonly objectType?: string | undefined;
+            readonly itemType?: FieldType;
+            readonly itemObjectType?: string | undefined;
+            readonly keytype?: string;
+            readonly xmlTag?: string;
+            readonly varname?: string;
+            readonly xmlType?: string;
+            readonly isBase64?: boolean;
+            readonly varkeytype?: string;
+            readonly vartype?: string;
+            readonly defaultValue?: any;
+            readonly name: string;
+            readonly type: "boolean";
         }];
         readonly description: "Check if topic is visible";
     };
@@ -13215,7 +13515,10 @@ type CobriliClientInterface = {
     call<K extends keyof typeof API_METHODS>(method: K, params: InferRequest<K>): Promise<ApiResponse<InferResponse<K>>>;
     getConfig(): Required<CobriliConfig>;
     setConfig(config: Partial<CobriliConfig>): void;
+    /** Initialize the Cobrili session. Must be called before making API calls. */
     init(hash?: string): Promise<any>;
+    /** Check if the client has been initialized. */
+    isInitialized(): boolean;
 };
 declare class CobriliClient {
     private config;
@@ -13231,7 +13534,11 @@ declare class CobriliClient {
      */
     init(hash?: string): Promise<any>;
     private performInit;
-    private ensureInitialized;
+    /**
+     * Check if the client has been initialized.
+     */
+    isInitialized(): boolean;
+    private assertInitialized;
     call<K extends keyof typeof API_METHODS>(methodName: K, params: InferRequest<K>): Promise<ApiResponse<InferResponse<K>>>;
     private sendHttpRequest;
 }