@nestbox-ai/documents 1.0.49 → 1.0.60

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.
@@ -12,42 +12,22 @@
12
12
  import type { Configuration } from './configuration';
13
13
  import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const COLLECTION_FORMATS: {
20
16
  csv: string;
21
17
  ssv: string;
22
18
  tsv: string;
23
19
  pipes: string;
24
20
  };
25
- /**
26
- *
27
- * @export
28
- * @interface RequestArgs
29
- */
30
21
  export interface RequestArgs {
31
22
  url: string;
32
23
  options: RawAxiosRequestConfig;
33
24
  }
34
- /**
35
- *
36
- * @export
37
- * @class BaseAPI
38
- */
39
25
  export declare class BaseAPI {
40
26
  protected basePath: string;
41
27
  protected axios: AxiosInstance;
42
28
  protected configuration: Configuration | undefined;
43
29
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
44
30
  }
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
31
  export declare class RequiredError extends Error {
52
32
  field: string;
53
33
  constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
58
38
  description: string;
59
39
  }[];
60
40
  }
61
- /**
62
- *
63
- * @export
64
- */
65
41
  export declare const operationServerMap: ServerMap;
66
42
  export {};
package/dist/esm/base.js CHANGED
@@ -13,21 +13,12 @@
13
13
  */
14
14
  import globalAxios from 'axios';
15
15
  export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
16
- /**
17
- *
18
- * @export
19
- */
20
16
  export const COLLECTION_FORMATS = {
21
17
  csv: ",",
22
18
  ssv: " ",
23
19
  tsv: "\t",
24
20
  pipes: "|",
25
21
  };
26
- /**
27
- *
28
- * @export
29
- * @class BaseAPI
30
- */
31
22
  export class BaseAPI {
32
23
  constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
33
24
  var _a;
@@ -40,12 +31,6 @@ export class BaseAPI {
40
31
  }
41
32
  }
42
33
  ;
43
- /**
44
- *
45
- * @export
46
- * @class RequiredError
47
- * @extends {Error}
48
- */
49
34
  export class RequiredError extends Error {
50
35
  constructor(field, msg) {
51
36
  super(msg);
@@ -53,8 +38,4 @@ export class RequiredError extends Error {
53
38
  this.name = "RequiredError";
54
39
  }
55
40
  }
56
- /**
57
- *
58
- * @export
59
- */
60
41
  export const operationServerMap = {};
@@ -12,54 +12,23 @@
12
12
  import type { Configuration } from "./configuration";
13
13
  import type { RequestArgs } from "./base";
14
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const DUMMY_BASE_URL = "https://example.com";
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
26
- /**
27
- *
28
- * @export
29
- */
30
21
  export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
- /**
32
- *
33
- * @export
34
- */
35
22
  export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
- /**
37
- *
38
- * @export
39
- */
40
23
  export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
- /**
42
- *
43
- * @export
44
- */
45
24
  export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
- /**
47
- *
48
- * @export
49
- */
50
25
  export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
51
26
  /**
52
- *
53
- * @export
27
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
28
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
29
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
54
30
  */
31
+ export declare const replaceWithSerializableTypeIfNeeded: (key: any, value: any) => any;
55
32
  export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
- /**
57
- *
58
- * @export
59
- */
60
33
  export declare const toPathString: (url: URL) => string;
61
- /**
62
- *
63
- * @export
64
- */
65
34
  export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
@@ -21,25 +21,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import { RequiredError } from "./base";
24
- /**
25
- *
26
- * @export
27
- */
28
24
  export const DUMMY_BASE_URL = 'https://example.com';
29
25
  /**
30
26
  *
31
27
  * @throws {RequiredError}
32
- * @export
33
28
  */
34
29
  export const assertParamExists = function (functionName, paramName, paramValue) {
35
30
  if (paramValue === null || paramValue === undefined) {
36
31
  throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
37
32
  }
38
33
  };
39
- /**
40
- *
41
- * @export
42
- */
43
34
  export const setApiKeyToObject = function (object, keyParamName, configuration) {
44
35
  return __awaiter(this, void 0, void 0, function* () {
45
36
  if (configuration && configuration.apiKey) {
@@ -50,19 +41,11 @@ export const setApiKeyToObject = function (object, keyParamName, configuration)
50
41
  }
51
42
  });
52
43
  };
53
- /**
54
- *
55
- * @export
56
- */
57
44
  export const setBasicAuthToObject = function (object, configuration) {
58
45
  if (configuration && (configuration.username || configuration.password)) {
59
46
  object["auth"] = { username: configuration.username, password: configuration.password };
60
47
  }
61
48
  };
62
- /**
63
- *
64
- * @export
65
- */
66
49
  export const setBearerAuthToObject = function (object, configuration) {
67
50
  return __awaiter(this, void 0, void 0, function* () {
68
51
  if (configuration && configuration.accessToken) {
@@ -73,10 +56,6 @@ export const setBearerAuthToObject = function (object, configuration) {
73
56
  }
74
57
  });
75
58
  };
76
- /**
77
- *
78
- * @export
79
- */
80
59
  export const setOAuthToObject = function (object, name, scopes, configuration) {
81
60
  return __awaiter(this, void 0, void 0, function* () {
82
61
  if (configuration && configuration.accessToken) {
@@ -91,7 +70,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
91
70
  if (parameter == null)
92
71
  return;
93
72
  if (typeof parameter === "object") {
94
- if (Array.isArray(parameter)) {
73
+ if (Array.isArray(parameter) || parameter instanceof Set) {
95
74
  parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
96
75
  }
97
76
  else {
@@ -107,39 +86,36 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
107
86
  }
108
87
  }
109
88
  }
110
- /**
111
- *
112
- * @export
113
- */
114
89
  export const setSearchParams = function (url, ...objects) {
115
90
  const searchParams = new URLSearchParams(url.search);
116
91
  setFlattenedQueryParams(searchParams, objects);
117
92
  url.search = searchParams.toString();
118
93
  };
119
94
  /**
120
- *
121
- * @export
95
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
96
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
97
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
122
98
  */
99
+ export const replaceWithSerializableTypeIfNeeded = function (key, value) {
100
+ if (value instanceof Set) {
101
+ return Array.from(value);
102
+ }
103
+ else {
104
+ return value;
105
+ }
106
+ };
123
107
  export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
124
108
  const nonString = typeof value !== 'string';
125
109
  const needsSerialization = nonString && configuration && configuration.isJsonMime
126
110
  ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
127
111
  : nonString;
128
112
  return needsSerialization
129
- ? JSON.stringify(value !== undefined ? value : {})
113
+ ? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
130
114
  : (value || "");
131
115
  };
132
- /**
133
- *
134
- * @export
135
- */
136
116
  export const toPathString = function (url) {
137
117
  return url.pathname + url.search + url.hash;
138
118
  };
139
- /**
140
- *
141
- * @export
142
- */
143
119
  export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
144
120
  return (axios = globalAxios, basePath = BASE_PATH) => {
145
121
  var _a;
@@ -9,11 +9,23 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ interface AWSv4Configuration {
13
+ options?: {
14
+ region?: string;
15
+ service?: string;
16
+ };
17
+ credentials?: {
18
+ accessKeyId?: string;
19
+ secretAccessKey?: string;
20
+ sessionToken?: string;
21
+ };
22
+ }
12
23
  export interface ConfigurationParameters {
13
24
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
25
  username?: string;
15
26
  password?: string;
16
27
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
+ awsv4?: AWSv4Configuration;
17
29
  basePath?: string;
18
30
  serverIndex?: number;
19
31
  baseOptions?: any;
@@ -23,49 +35,43 @@ export declare class Configuration {
23
35
  /**
24
36
  * parameter for apiKey security
25
37
  * @param name security name
26
- * @memberof Configuration
27
38
  */
28
39
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
40
  /**
30
41
  * parameter for basic security
31
- *
32
- * @type {string}
33
- * @memberof Configuration
34
42
  */
35
43
  username?: string;
36
44
  /**
37
45
  * parameter for basic security
38
- *
39
- * @type {string}
40
- * @memberof Configuration
41
46
  */
42
47
  password?: string;
43
48
  /**
44
49
  * parameter for oauth2 security
45
50
  * @param name security name
46
51
  * @param scopes oauth2 scope
47
- * @memberof Configuration
48
52
  */
49
53
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
50
54
  /**
51
- * override base path
52
- *
53
- * @type {string}
55
+ * parameter for aws4 signature security
56
+ * @param {Object} AWS4Signature - AWS4 Signature security
57
+ * @param {string} options.region - aws region
58
+ * @param {string} options.service - name of the service.
59
+ * @param {string} credentials.accessKeyId - aws access key id
60
+ * @param {string} credentials.secretAccessKey - aws access key
61
+ * @param {string} credentials.sessionToken - aws session token
54
62
  * @memberof Configuration
55
63
  */
64
+ awsv4?: AWSv4Configuration;
65
+ /**
66
+ * override base path
67
+ */
56
68
  basePath?: string;
57
69
  /**
58
70
  * override server index
59
- *
60
- * @type {number}
61
- * @memberof Configuration
62
71
  */
63
72
  serverIndex?: number;
64
73
  /**
65
74
  * base options for axios calls
66
- *
67
- * @type {any}
68
- * @memberof Configuration
69
75
  */
70
76
  baseOptions?: any;
71
77
  /**
@@ -89,3 +95,4 @@ export declare class Configuration {
89
95
  */
90
96
  isJsonMime(mime: string): boolean;
91
97
  }
98
+ export {};
@@ -1,5 +1,4 @@
1
1
  /* tslint:disable */
2
- /* eslint-disable */
3
2
  /**
4
3
  * Nestbox API Documents API
5
4
  * API for Nestbox Documents, control your documents
@@ -18,6 +17,7 @@ export class Configuration {
18
17
  this.username = param.username;
19
18
  this.password = param.password;
20
19
  this.accessToken = param.accessToken;
20
+ this.awsv4 = param.awsv4;
21
21
  this.basePath = param.basePath;
22
22
  this.serverIndex = param.serverIndex;
23
23
  this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
package/git_push.sh CHANGED
@@ -14,12 +14,12 @@ if [ "$git_host" = "" ]; then
14
14
  fi
15
15
 
16
16
  if [ "$git_user_id" = "" ]; then
17
- git_user_id="GIT_USER_ID"
17
+ git_user_id="NestboxAI"
18
18
  echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
19
19
  fi
20
20
 
21
21
  if [ "$git_repo_id" = "" ]; then
22
- git_repo_id="GIT_REPO_ID"
22
+ git_repo_id="nestbox-ai-clients"
23
23
  echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
24
24
  fi
25
25
 
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@nestbox-ai/documents",
3
- "version": "1.0.49",
3
+ "version": "1.0.60",
4
4
  "description": "OpenAPI client for @nestbox-ai/documents",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
7
7
  "type": "git",
8
- "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
8
+ "url": "https://github.com/NestboxAI/nestbox-ai-clients.git"
9
9
  },
10
10
  "keywords": [
11
11
  "axios",