@icepanel/sdk 0.0.37 → 0.0.38

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.
package/README.md CHANGED
@@ -9,7 +9,7 @@ The IcePanel TypeScript library provides convenient access to the IcePanel APIs
9
9
 
10
10
  - [Installation](#installation)
11
11
  - [Reference](#reference)
12
- - [Latest Helper](#latest-helper)
12
+ - [Helpers](#helpers)
13
13
  - [Usage](#usage)
14
14
  - [Request and Response Types](#request-and-response-types)
15
15
  - [Exception Handling](#exception-handling)
@@ -34,33 +34,19 @@ npm i -s @icepanel/sdk
34
34
 
35
35
  A full reference for this library is available [here](https://github.com/IcePanel/icepanel-js/blob/HEAD/./reference.md).
36
36
 
37
- ## Latest Helper
37
+ ## Usage
38
38
 
39
39
  Use the following constant to specify the latest version.
40
40
  ```typescript
41
41
  import { IcePanelClient, LandscapeVersion } from "@icepanel/sdk";
42
42
 
43
- const landscapeId = "landscapeId";
44
-
45
- const client = new IcePanelClient({ apiKey: "YOUR_API_KEY", authorization: "YOUR_AUTHORIZATION" });
46
- await client.model.objects.list({
47
- landscapeId,
48
- versionId: LandscapeVersion.Latest
43
+ const client = new IcePanelClient({
44
+ apiKey: "YOUR_API_KEY",
45
+ apiVersion: "v1"
49
46
  });
50
- ```
51
-
52
-
53
- ## Usage
54
-
55
- Instantiate and use the client with the following:
56
-
57
- ```typescript
58
- import { IcePanelClient } from "@icepanel/sdk";
59
-
60
- const client = new IcePanelClient({ apiKey: "YOUR_API_KEY", authorization: "YOUR_AUTHORIZATION" });
61
47
  await client.model.objects.list({
62
- landscapeId: "landscapeId",
63
- versionId: "versionId"
48
+ landscapeId: "YOUR_LANDSCAPE_ID",
49
+ versionId: LandscapeVersion.Latest
64
50
  });
65
51
  ```
66
52
 
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@icepanel/sdk",
46
- "X-Fern-SDK-Version": "0.0.37",
47
- "User-Agent": "@icepanel/sdk/0.0.37",
46
+ "X-Fern-SDK-Version": "0.0.38",
47
+ "User-Agent": "@icepanel/sdk/0.0.38",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -51,13 +51,13 @@ class IcePanelClient extends Client_1.IcePanelClient {
51
51
  updatedOptions.baseUrl = () => __awaiter(this, void 0, void 0, function* () {
52
52
  const baseUrl = options.baseUrl ? yield core.Supplier.get(options.baseUrl) : undefined;
53
53
  if (baseUrl) {
54
- return `${baseUrl}/${options.apiVersion}`;
54
+ return `https://${baseUrl}/${options.apiVersion}`;
55
55
  }
56
56
  const environment = options.environment ? yield core.Supplier.get(options.environment) : undefined;
57
57
  if (environment) {
58
- return `api.${environment}.icepanel.cloud/${options.apiVersion}`;
58
+ return `https://api.${environment}.icepanel.cloud/${options.apiVersion}`;
59
59
  }
60
- return `api.icepanel.io/${options.apiVersion}`;
60
+ return `https://api.icepanel.io/${options.apiVersion}`;
61
61
  });
62
62
  if (options.apiKey) {
63
63
  updatedOptions.headers = Object.assign(Object.assign({}, updatedOptions.headers), { 'X-API-Key': options.apiKey });
@@ -0,0 +1,9 @@
1
+ export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
2
+ export { IcePanelClient } from "./IcePanelClient.js";
3
+ export { IcePanelEnvironment } from "./environments.js";
4
+ export { IcePanelError, IcePanelTimeoutError } from "./errors/index.js";
5
+ export * from "./exports.js";
6
+ export * from './types.js';
7
+ export * as IcePanel from './types.js';
8
+ export * from './helpers/index.js';
9
+ export * from './consts.js';
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
19
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
20
+ };
21
+ var __importStar = (this && this.__importStar) || (function () {
22
+ var ownKeys = function(o) {
23
+ ownKeys = Object.getOwnPropertyNames || function (o) {
24
+ var ar = [];
25
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
+ return ar;
27
+ };
28
+ return ownKeys(o);
29
+ };
30
+ return function (mod) {
31
+ if (mod && mod.__esModule) return mod;
32
+ var result = {};
33
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
+ __setModuleDefault(result, mod);
35
+ return result;
36
+ };
37
+ })();
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.IcePanel = exports.IcePanelTimeoutError = exports.IcePanelError = exports.IcePanelEnvironment = exports.IcePanelClient = void 0;
40
+ var IcePanelClient_js_1 = require("./IcePanelClient.js");
41
+ Object.defineProperty(exports, "IcePanelClient", { enumerable: true, get: function () { return IcePanelClient_js_1.IcePanelClient; } });
42
+ var environments_js_1 = require("./environments.js");
43
+ Object.defineProperty(exports, "IcePanelEnvironment", { enumerable: true, get: function () { return environments_js_1.IcePanelEnvironment; } });
44
+ var index_js_1 = require("./errors/index.js");
45
+ Object.defineProperty(exports, "IcePanelError", { enumerable: true, get: function () { return index_js_1.IcePanelError; } });
46
+ Object.defineProperty(exports, "IcePanelTimeoutError", { enumerable: true, get: function () { return index_js_1.IcePanelTimeoutError; } });
47
+ __exportStar(require("./exports.js"), exports);
48
+ __exportStar(require("./types.js"), exports);
49
+ exports.IcePanel = __importStar(require("./types.js"));
50
+ __exportStar(require("./helpers/index.js"), exports);
51
+ __exportStar(require("./consts.js"), exports);
@@ -1,9 +1,6 @@
1
+ export * as IcePanel from "./api/index.js";
1
2
  export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
2
- export { IcePanelClient } from "./IcePanelClient.js";
3
+ export { IcePanelClient } from "./Client.js";
3
4
  export { IcePanelEnvironment } from "./environments.js";
4
5
  export { IcePanelError, IcePanelTimeoutError } from "./errors/index.js";
5
6
  export * from "./exports.js";
6
- export * from './types.js';
7
- export * as IcePanel from './types.js';
8
- export * from './helpers/index.js';
9
- export * from './consts.js';
package/dist/cjs/index.js CHANGED
@@ -15,9 +15,6 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
15
15
  }) : function(o, v) {
16
16
  o["default"] = v;
17
17
  });
18
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
19
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
20
- };
21
18
  var __importStar = (this && this.__importStar) || (function () {
22
19
  var ownKeys = function(o) {
23
20
  ownKeys = Object.getOwnPropertyNames || function (o) {
@@ -35,17 +32,17 @@ var __importStar = (this && this.__importStar) || (function () {
35
32
  return result;
36
33
  };
37
34
  })();
35
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
36
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
37
+ };
38
38
  Object.defineProperty(exports, "__esModule", { value: true });
39
- exports.IcePanel = exports.IcePanelTimeoutError = exports.IcePanelError = exports.IcePanelEnvironment = exports.IcePanelClient = void 0;
40
- var IcePanelClient_js_1 = require("./IcePanelClient.js");
41
- Object.defineProperty(exports, "IcePanelClient", { enumerable: true, get: function () { return IcePanelClient_js_1.IcePanelClient; } });
39
+ exports.IcePanelTimeoutError = exports.IcePanelError = exports.IcePanelEnvironment = exports.IcePanelClient = exports.IcePanel = void 0;
40
+ exports.IcePanel = __importStar(require("./api/index.js"));
41
+ var Client_js_1 = require("./Client.js");
42
+ Object.defineProperty(exports, "IcePanelClient", { enumerable: true, get: function () { return Client_js_1.IcePanelClient; } });
42
43
  var environments_js_1 = require("./environments.js");
43
44
  Object.defineProperty(exports, "IcePanelEnvironment", { enumerable: true, get: function () { return environments_js_1.IcePanelEnvironment; } });
44
45
  var index_js_1 = require("./errors/index.js");
45
46
  Object.defineProperty(exports, "IcePanelError", { enumerable: true, get: function () { return index_js_1.IcePanelError; } });
46
47
  Object.defineProperty(exports, "IcePanelTimeoutError", { enumerable: true, get: function () { return index_js_1.IcePanelTimeoutError; } });
47
48
  __exportStar(require("./exports.js"), exports);
48
- __exportStar(require("./types.js"), exports);
49
- exports.IcePanel = __importStar(require("./types.js"));
50
- __exportStar(require("./helpers/index.js"), exports);
51
- __exportStar(require("./consts.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.0.37";
1
+ export declare const SDK_VERSION = "0.0.38";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.0.37";
4
+ exports.SDK_VERSION = "0.0.38";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "@icepanel/sdk",
9
- "X-Fern-SDK-Version": "0.0.37",
10
- "User-Agent": "@icepanel/sdk/0.0.37",
9
+ "X-Fern-SDK-Version": "0.0.38",
10
+ "User-Agent": "@icepanel/sdk/0.0.38",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  }, options === null || options === void 0 ? void 0 : options.headers);
@@ -15,13 +15,13 @@ export class IcePanelClient extends Client {
15
15
  updatedOptions.baseUrl = () => __awaiter(this, void 0, void 0, function* () {
16
16
  const baseUrl = options.baseUrl ? yield core.Supplier.get(options.baseUrl) : undefined;
17
17
  if (baseUrl) {
18
- return `${baseUrl}/${options.apiVersion}`;
18
+ return `https://${baseUrl}/${options.apiVersion}`;
19
19
  }
20
20
  const environment = options.environment ? yield core.Supplier.get(options.environment) : undefined;
21
21
  if (environment) {
22
- return `api.${environment}.icepanel.cloud/${options.apiVersion}`;
22
+ return `https://api.${environment}.icepanel.cloud/${options.apiVersion}`;
23
23
  }
24
- return `api.icepanel.io/${options.apiVersion}`;
24
+ return `https://api.icepanel.io/${options.apiVersion}`;
25
25
  });
26
26
  if (options.apiKey) {
27
27
  updatedOptions.headers = Object.assign(Object.assign({}, updatedOptions.headers), { 'X-API-Key': options.apiKey });
@@ -0,0 +1,9 @@
1
+ export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.mjs";
2
+ export { IcePanelClient } from "./IcePanelClient.mjs";
3
+ export { IcePanelEnvironment } from "./environments.mjs";
4
+ export { IcePanelError, IcePanelTimeoutError } from "./errors/index.mjs";
5
+ export * from "./exports.mjs";
6
+ export * from './types.mjs';
7
+ export * as IcePanel from './types.mjs';
8
+ export * from './helpers/index.mjs';
9
+ export * from './consts.mjs';
@@ -0,0 +1,8 @@
1
+ export { IcePanelClient } from "./IcePanelClient.mjs";
2
+ export { IcePanelEnvironment } from "./environments.mjs";
3
+ export { IcePanelError, IcePanelTimeoutError } from "./errors/index.mjs";
4
+ export * from "./exports.mjs";
5
+ export * from './types.mjs';
6
+ export * as IcePanel from './types.mjs';
7
+ export * from './helpers/index.mjs';
8
+ export * from './consts.mjs';
@@ -1,9 +1,6 @@
1
+ export * as IcePanel from "./api/index.mjs";
1
2
  export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.mjs";
2
- export { IcePanelClient } from "./IcePanelClient.mjs";
3
+ export { IcePanelClient } from "./Client.mjs";
3
4
  export { IcePanelEnvironment } from "./environments.mjs";
4
5
  export { IcePanelError, IcePanelTimeoutError } from "./errors/index.mjs";
5
6
  export * from "./exports.mjs";
6
- export * from './types.mjs';
7
- export * as IcePanel from './types.mjs';
8
- export * from './helpers/index.mjs';
9
- export * from './consts.mjs';
@@ -1,8 +1,5 @@
1
- export { IcePanelClient } from "./IcePanelClient.mjs";
1
+ export * as IcePanel from "./api/index.mjs";
2
+ export { IcePanelClient } from "./Client.mjs";
2
3
  export { IcePanelEnvironment } from "./environments.mjs";
3
4
  export { IcePanelError, IcePanelTimeoutError } from "./errors/index.mjs";
4
5
  export * from "./exports.mjs";
5
- export * from './types.mjs';
6
- export * as IcePanel from './types.mjs';
7
- export * from './helpers/index.mjs';
8
- export * from './consts.mjs';
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.0.37";
1
+ export declare const SDK_VERSION = "0.0.38";
@@ -1 +1 @@
1
- export const SDK_VERSION = "0.0.37";
1
+ export const SDK_VERSION = "0.0.38";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@icepanel/sdk",
3
- "version": "0.0.37",
3
+ "version": "0.0.38",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",