@aws-sdk/client-iotsitewise 3.31.0 → 3.35.0

package/src/runtimeConfig.browser.ts

@@ -0,0 +1,41 @@
+import { Sha256 } from "@aws-crypto/sha256-browser";
+import { FetchHttpHandler, streamCollector } from "@aws-sdk/fetch-http-handler";
+import { invalidProvider } from "@aws-sdk/invalid-dependency";
+import { DEFAULT_MAX_ATTEMPTS, DEFAULT_RETRY_MODE } from "@aws-sdk/middleware-retry";
+import { fromBase64, toBase64 } from "@aws-sdk/util-base64-browser";
+import { calculateBodyLength } from "@aws-sdk/util-body-length-browser";
+import { defaultUserAgent } from "@aws-sdk/util-user-agent-browser";
+import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-browser";
+
+// @ts-ignore: package.json will be imported from dist folders
+import packageInfo from "../package.json";
+import { IoTSiteWiseClientConfig } from "./IoTSiteWiseClient";
+import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
+
+/**
+ * @internal
+ */
+export const getRuntimeConfig = (config: IoTSiteWiseClientConfig) => {
+  const clientSharedValues = getSharedRuntimeConfig(config);
+  return {
+    ...clientSharedValues,
+    ...config,
+    runtime: "browser",
+    base64Decoder: config?.base64Decoder ?? fromBase64,
+    base64Encoder: config?.base64Encoder ?? toBase64,
+    bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
+    credentialDefaultProvider:
+      config?.credentialDefaultProvider ?? ((_: unknown) => () => Promise.reject(new Error("Credential is missing"))),
+    defaultUserAgentProvider:
+      config?.defaultUserAgentProvider ??
+      defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
+    maxAttempts: config?.maxAttempts ?? DEFAULT_MAX_ATTEMPTS,
+    region: config?.region ?? invalidProvider("Region is missing"),
+    requestHandler: config?.requestHandler ?? new FetchHttpHandler(),
+    retryMode: config?.retryMode ?? (() => Promise.resolve(DEFAULT_RETRY_MODE)),
+    sha256: config?.sha256 ?? Sha256,
+    streamCollector: config?.streamCollector ?? streamCollector,
+    utf8Decoder: config?.utf8Decoder ?? fromUtf8,
+    utf8Encoder: config?.utf8Encoder ?? toUtf8,
+  };
+};

package/src/runtimeConfig.native.ts

@@ -0,0 +1,17 @@
+import { Sha256 } from "@aws-crypto/sha256-js";
+
+import { IoTSiteWiseClientConfig } from "./IoTSiteWiseClient";
+import { getRuntimeConfig as getBrowserRuntimeConfig } from "./runtimeConfig.browser";
+
+/**
+ * @internal
+ */
+export const getRuntimeConfig = (config: IoTSiteWiseClientConfig) => {
+  const browserDefaults = getBrowserRuntimeConfig(config);
+  return {
+    ...browserDefaults,
+    ...config,
+    runtime: "react-native",
+    sha256: config?.sha256 ?? Sha256,
+  };
+};

package/src/runtimeConfig.shared.ts

@@ -0,0 +1,17 @@
+import { Logger as __Logger } from "@aws-sdk/types";
+import { parseUrl } from "@aws-sdk/url-parser";
+
+import { defaultRegionInfoProvider } from "./endpoints";
+import { IoTSiteWiseClientConfig } from "./IoTSiteWiseClient";
+
+/**
+ * @internal
+ */
+export const getRuntimeConfig = (config: IoTSiteWiseClientConfig) => ({
+  apiVersion: "2019-12-02",
+  disableHostPrefix: config?.disableHostPrefix ?? false,
+  logger: config?.logger ?? ({} as __Logger),
+  regionInfoProvider: config?.regionInfoProvider ?? defaultRegionInfoProvider,
+  serviceId: config?.serviceId ?? "IoTSiteWise",
+  urlParser: config?.urlParser ?? parseUrl,
+});

package/src/runtimeConfig.ts

@@ -0,0 +1,46 @@
+import { decorateDefaultCredentialProvider } from "@aws-sdk/client-sts";
+import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS } from "@aws-sdk/config-resolver";
+import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
+import { Hash } from "@aws-sdk/hash-node";
+import { NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS } from "@aws-sdk/middleware-retry";
+import { loadConfig as loadNodeConfig } from "@aws-sdk/node-config-provider";
+import { NodeHttpHandler, streamCollector } from "@aws-sdk/node-http-handler";
+import { emitWarningIfUnsupportedVersion } from "@aws-sdk/smithy-client";
+import { fromBase64, toBase64 } from "@aws-sdk/util-base64-node";
+import { calculateBodyLength } from "@aws-sdk/util-body-length-node";
+import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
+import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
+
+// @ts-ignore: package.json will be imported from dist folders
+import packageInfo from "../package.json";
+import { IoTSiteWiseClientConfig } from "./IoTSiteWiseClient";
+import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
+
+/**
+ * @internal
+ */
+export const getRuntimeConfig = (config: IoTSiteWiseClientConfig) => {
+  emitWarningIfUnsupportedVersion(process.version);
+  const clientSharedValues = getSharedRuntimeConfig(config);
+  return {
+    ...clientSharedValues,
+    ...config,
+    runtime: "node",
+    base64Decoder: config?.base64Decoder ?? fromBase64,
+    base64Encoder: config?.base64Encoder ?? toBase64,
+    bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
+    credentialDefaultProvider:
+      config?.credentialDefaultProvider ?? decorateDefaultCredentialProvider(credentialDefaultProvider),
+    defaultUserAgentProvider:
+      config?.defaultUserAgentProvider ??
+      defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
+    maxAttempts: config?.maxAttempts ?? loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),
+    region: config?.region ?? loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),
+    requestHandler: config?.requestHandler ?? new NodeHttpHandler(),
+    retryMode: config?.retryMode ?? loadNodeConfig(NODE_RETRY_MODE_CONFIG_OPTIONS),
+    sha256: config?.sha256 ?? Hash.bind(null, "sha256"),
+    streamCollector: config?.streamCollector ?? streamCollector,
+    utf8Decoder: config?.utf8Decoder ?? fromUtf8,
+    utf8Encoder: config?.utf8Encoder ?? toUtf8,
+  };
+};

package/src/waiters/waitForAssetActive.ts

@@ -0,0 +1,55 @@
+import { checkExceptions, createWaiter, WaiterConfiguration, WaiterResult, WaiterState } from "@aws-sdk/util-waiter";
+
+import { DescribeAssetCommand, DescribeAssetCommandInput } from "../commands/DescribeAssetCommand";
+import { IoTSiteWiseClient } from "../IoTSiteWiseClient";
+
+const checkState = async (client: IoTSiteWiseClient, input: DescribeAssetCommandInput): Promise<WaiterResult> => {
+  let reason;
+  try {
+    const result: any = await client.send(new DescribeAssetCommand(input));
+    reason = result;
+    try {
+      const returnComparator = () => {
+        return result.assetStatus.state;
+      };
+      if (returnComparator() === "ACTIVE") {
+        return { state: WaiterState.SUCCESS, reason };
+      }
+    } catch (e) {}
+    try {
+      const returnComparator = () => {
+        return result.assetStatus.state;
+      };
+      if (returnComparator() === "FAILED") {
+        return { state: WaiterState.FAILURE, reason };
+      }
+    } catch (e) {}
+  } catch (exception) {
+    reason = exception;
+  }
+  return { state: WaiterState.RETRY, reason };
+};
+/**
+ *
+ *  @deprecated Use waitUntilAssetActive instead. waitForAssetActive does not throw error in non-success cases.
+ */
+export const waitForAssetActive = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribeAssetCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+};
+/**
+ *
+ *  @param params - Waiter configuration options.
+ *  @param input - The input to DescribeAssetCommand for polling.
+ */
+export const waitUntilAssetActive = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribeAssetCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+  return checkExceptions(result);
+};

package/src/waiters/waitForAssetModelActive.ts

@@ -0,0 +1,55 @@
+import { checkExceptions, createWaiter, WaiterConfiguration, WaiterResult, WaiterState } from "@aws-sdk/util-waiter";
+
+import { DescribeAssetModelCommand, DescribeAssetModelCommandInput } from "../commands/DescribeAssetModelCommand";
+import { IoTSiteWiseClient } from "../IoTSiteWiseClient";
+
+const checkState = async (client: IoTSiteWiseClient, input: DescribeAssetModelCommandInput): Promise<WaiterResult> => {
+  let reason;
+  try {
+    const result: any = await client.send(new DescribeAssetModelCommand(input));
+    reason = result;
+    try {
+      const returnComparator = () => {
+        return result.assetModelStatus.state;
+      };
+      if (returnComparator() === "ACTIVE") {
+        return { state: WaiterState.SUCCESS, reason };
+      }
+    } catch (e) {}
+    try {
+      const returnComparator = () => {
+        return result.assetModelStatus.state;
+      };
+      if (returnComparator() === "FAILED") {
+        return { state: WaiterState.FAILURE, reason };
+      }
+    } catch (e) {}
+  } catch (exception) {
+    reason = exception;
+  }
+  return { state: WaiterState.RETRY, reason };
+};
+/**
+ *
+ *  @deprecated Use waitUntilAssetModelActive instead. waitForAssetModelActive does not throw error in non-success cases.
+ */
+export const waitForAssetModelActive = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribeAssetModelCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+};
+/**
+ *
+ *  @param params - Waiter configuration options.
+ *  @param input - The input to DescribeAssetModelCommand for polling.
+ */
+export const waitUntilAssetModelActive = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribeAssetModelCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+  return checkExceptions(result);
+};

package/src/waiters/waitForAssetModelNotExists.ts

@@ -0,0 +1,42 @@
+import { checkExceptions, createWaiter, WaiterConfiguration, WaiterResult, WaiterState } from "@aws-sdk/util-waiter";
+
+import { DescribeAssetModelCommand, DescribeAssetModelCommandInput } from "../commands/DescribeAssetModelCommand";
+import { IoTSiteWiseClient } from "../IoTSiteWiseClient";
+
+const checkState = async (client: IoTSiteWiseClient, input: DescribeAssetModelCommandInput): Promise<WaiterResult> => {
+  let reason;
+  try {
+    const result: any = await client.send(new DescribeAssetModelCommand(input));
+    reason = result;
+  } catch (exception) {
+    reason = exception;
+    if (exception.name && exception.name == "ResourceNotFoundException") {
+      return { state: WaiterState.SUCCESS, reason };
+    }
+  }
+  return { state: WaiterState.RETRY, reason };
+};
+/**
+ *
+ *  @deprecated Use waitUntilAssetModelNotExists instead. waitForAssetModelNotExists does not throw error in non-success cases.
+ */
+export const waitForAssetModelNotExists = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribeAssetModelCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+};
+/**
+ *
+ *  @param params - Waiter configuration options.
+ *  @param input - The input to DescribeAssetModelCommand for polling.
+ */
+export const waitUntilAssetModelNotExists = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribeAssetModelCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+  return checkExceptions(result);
+};

package/src/waiters/waitForAssetNotExists.ts

@@ -0,0 +1,42 @@
+import { checkExceptions, createWaiter, WaiterConfiguration, WaiterResult, WaiterState } from "@aws-sdk/util-waiter";
+
+import { DescribeAssetCommand, DescribeAssetCommandInput } from "../commands/DescribeAssetCommand";
+import { IoTSiteWiseClient } from "../IoTSiteWiseClient";
+
+const checkState = async (client: IoTSiteWiseClient, input: DescribeAssetCommandInput): Promise<WaiterResult> => {
+  let reason;
+  try {
+    const result: any = await client.send(new DescribeAssetCommand(input));
+    reason = result;
+  } catch (exception) {
+    reason = exception;
+    if (exception.name && exception.name == "ResourceNotFoundException") {
+      return { state: WaiterState.SUCCESS, reason };
+    }
+  }
+  return { state: WaiterState.RETRY, reason };
+};
+/**
+ *
+ *  @deprecated Use waitUntilAssetNotExists instead. waitForAssetNotExists does not throw error in non-success cases.
+ */
+export const waitForAssetNotExists = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribeAssetCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+};
+/**
+ *
+ *  @param params - Waiter configuration options.
+ *  @param input - The input to DescribeAssetCommand for polling.
+ */
+export const waitUntilAssetNotExists = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribeAssetCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+  return checkExceptions(result);
+};

package/src/waiters/waitForPortalActive.ts

@@ -0,0 +1,47 @@
+import { checkExceptions, createWaiter, WaiterConfiguration, WaiterResult, WaiterState } from "@aws-sdk/util-waiter";
+
+import { DescribePortalCommand, DescribePortalCommandInput } from "../commands/DescribePortalCommand";
+import { IoTSiteWiseClient } from "../IoTSiteWiseClient";
+
+const checkState = async (client: IoTSiteWiseClient, input: DescribePortalCommandInput): Promise<WaiterResult> => {
+  let reason;
+  try {
+    const result: any = await client.send(new DescribePortalCommand(input));
+    reason = result;
+    try {
+      const returnComparator = () => {
+        return result.portalStatus.state;
+      };
+      if (returnComparator() === "ACTIVE") {
+        return { state: WaiterState.SUCCESS, reason };
+      }
+    } catch (e) {}
+  } catch (exception) {
+    reason = exception;
+  }
+  return { state: WaiterState.RETRY, reason };
+};
+/**
+ *
+ *  @deprecated Use waitUntilPortalActive instead. waitForPortalActive does not throw error in non-success cases.
+ */
+export const waitForPortalActive = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribePortalCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+};
+/**
+ *
+ *  @param params - Waiter configuration options.
+ *  @param input - The input to DescribePortalCommand for polling.
+ */
+export const waitUntilPortalActive = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribePortalCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+  return checkExceptions(result);
+};

package/src/waiters/waitForPortalNotExists.ts

@@ -0,0 +1,42 @@
+import { checkExceptions, createWaiter, WaiterConfiguration, WaiterResult, WaiterState } from "@aws-sdk/util-waiter";
+
+import { DescribePortalCommand, DescribePortalCommandInput } from "../commands/DescribePortalCommand";
+import { IoTSiteWiseClient } from "../IoTSiteWiseClient";
+
+const checkState = async (client: IoTSiteWiseClient, input: DescribePortalCommandInput): Promise<WaiterResult> => {
+  let reason;
+  try {
+    const result: any = await client.send(new DescribePortalCommand(input));
+    reason = result;
+  } catch (exception) {
+    reason = exception;
+    if (exception.name && exception.name == "ResourceNotFoundException") {
+      return { state: WaiterState.SUCCESS, reason };
+    }
+  }
+  return { state: WaiterState.RETRY, reason };
+};
+/**
+ *
+ *  @deprecated Use waitUntilPortalNotExists instead. waitForPortalNotExists does not throw error in non-success cases.
+ */
+export const waitForPortalNotExists = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribePortalCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+};
+/**
+ *
+ *  @param params - Waiter configuration options.
+ *  @param input - The input to DescribePortalCommand for polling.
+ */
+export const waitUntilPortalNotExists = async (
+  params: WaiterConfiguration<IoTSiteWiseClient>,
+  input: DescribePortalCommandInput
+): Promise<WaiterResult> => {
+  const serviceDefaults = { minDelay: 3, maxDelay: 120 };
+  const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
+  return checkExceptions(result);
+};

package/tsconfig.es.json

@@ -4,9 +4,7 @@
     "target": "es5",
     "module": "esnext",
     "moduleResolution": "node",
-    "declaration": false,
-    "declarationDir": null,
     "lib": ["dom", "es5", "es2015.promise", "es2015.collection", "es2015.iterable", "es2015.symbol.wellknown"],
-    "outDir": "dist/es"
+    "outDir": "dist-es"
   }
 }

package/tsconfig.json

@@ -3,7 +3,6 @@
     "alwaysStrict": true,
     "target": "ES2018",
     "module": "commonjs",
-    "declaration": true,
     "strict": true,
     "sourceMap": true,
     "downlevelIteration": true,
@@ -12,9 +11,9 @@
     "incremental": true,
     "resolveJsonModule": true,
     "esModuleInterop": true,
-    "declarationDir": "./dist/types",
-    "outDir": "dist/cjs",
-    "useUnknownInCatchVariables": false
+    "rootDir": "src",
+    "outDir": "dist-cjs",
+    "removeComments": true
   },
   "typedocOptions": {
     "exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],
@@ -24,10 +23,11 @@
     "ignoreCompilerErrors": true,
     "includeDeclarations": true,
     "stripInternal": true,
-    "readme": "./README.md",
+    "readme": "README.md",
     "mode": "file",
-    "out": "./docs",
+    "out": "docs",
     "theme": "minimal",
     "plugin": ["@aws-sdk/client-documentation-generator"]
-  }
+  },
+  "exclude": ["test/**/*"]
 }

package/tsconfig.types.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig",
+  "compilerOptions": {
+    "removeComments": false,
+    "declaration": true,
+    "declarationDir": "dist-types"
+  },
+  "exclude": ["test/**/*", "dist-types/**/*"]
+}