Merge pull request #6 from oracle/release_2020-06-16

Releasing version 1.1.1

Author: waruwaruwaru

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## 1.1.1 - 2020-06-16
+
+### Added
+
+- Support for creating a new database from an existing database based on a given timestamp in the Database service
+- Support for enabling archive log backups of databases in the Database service
+- Support for returning the database version on autonomous container databases in the Database service
+- Support for the new DNS format of the Data Transfer service
+- Support for scheduled autoscaling, which allows for scaling actions triggered at particular times based on CRON expressions, in the Compute Autoscaling service
+- Support for filtering of list APIs for groups, identity providers, identity provider groups, compartments, dynamic groups, network sources, policies, and users by name or lifecycle state in the Identity Service
+
 ## 1.1.0 - 2020-06-09
 
 ### Added

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to the Oracle Cloud Infrastructure SDK for TypeScript
+# Contributing to the Oracle Cloud Infrastructure SDK for TypeScript and JavaScript
 
 _Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved._
 

README-development.md

@@ -1,4 +1,4 @@
-# Oracle Cloud Infrastructure SDK for TypeScript Development
+# Oracle Cloud Infrastructure SDK for TypeScript and JavaScript Development
 
 ## Getting Started
 

README.md

@@ -1,9 +1,9 @@
-# Oracle Cloud Infrastructure SDK for Typescript
+# Oracle Cloud Infrastructure SDK for TypeScript and JavaScript
 
 [![wercker status](https://app.wercker.com/status/09bc4818e7b1d70b04285331a9bdbc41/s/master "wercker status")](https://app.wercker.com/project/byKey/09bc4818e7b1d70b04285331a9bdbc41)
 
-This is Oracle Cloud Infrastructure SDK for TypeScript. (Note that the SDK works with both JavaScript and TypeScript projects.) This project is open source and maintained by Oracle Corp.
-The home page for the project is [Oracle Cloud Infrastructure SDK for TypeScript](https://github.com/oracle/oci-typescript-sdk/).
+This is Oracle Cloud Infrastructure SDK for TypeScript and JavaScript. (Note that the SDK works with both JavaScript and TypeScript projects.) This project is open source and maintained by Oracle Corp.
+The home page for the project is [Oracle Cloud Infrastructure SDK for TypeScript and JavaScript](https://github.com/oracle/oci-typescript-sdk/).
 
 ## Installing
 
@@ -15,9 +15,9 @@ npm install oci-sdk
 
 Alternatively you can git clone this repo.
 
-## Working with the SDK for TypeScript
+## Working with the SDK for TypeScript and JavaScript
 
-To start working with the SDK for TypeScript, you import the service package, create a client, and then use that client to make calls. [Refer to examples section](https://github.com/oracle/oci-typescript-sdk/tree/master/examples) for examples on how to make requests.
+To start working with the SDK for TypeScript and JavaScript, you import the service package, create a client, and then use that client to make calls. [Refer to examples section](https://github.com/oracle/oci-typescript-sdk/tree/master/examples) for examples on how to make requests.
 
 ### Configuring
 
@@ -28,7 +28,7 @@ Before using the SDK, set up a config file with the required credentials. See [S
 The `oci-typescript-sdk` contains the following:
 
 - **Service packages**: All packages except `common` and any other package found inside `lib`. These packages represent
-  the Oracle Cloud Infrastructure services supported by the SDK for TypeScript. Each package represents a service.
+  the Oracle Cloud Infrastructure services supported by the SDK for TypeScript and JavaScript. Each package represents a service.
   These packages include methods to interact with the service, structs that model
   input and output parameters, and a client struct that acts as receiver for the above methods.
 
@@ -42,15 +42,15 @@ Examples can be found [in the examples section](https://github.com/oracle/oci-ty
 
 ## Documentation
 
-Full documentation can be found [on the sdk for typescript documentation site](https://docs.cloud.oracle.com/en-us/iaas/Content/API/SDKDocs/typescriptsdk.htm).
+Full documentation can be found [on the sdk for typescript and javascript documentation site](https://docs.cloud.oracle.com/en-us/iaas/Content/API/SDKDocs/typescriptsdk.htm).
 
 ## Versions Supported
 
-The SDK for TypeScript currently supports NodeJS version 10.15.3 and TypeScript version 3.6.4.
+The SDK for TypeScript and JavaScript currently supports NodeJS version 10.15.3 and TypeScript version 3.6.4.
 
 ## Node & Browser Support
 
-The SDK for TypeScript currently supports NodeJS but does not have browser support.
+The SDK for TypeScript and JavaScript currently supports NodeJS but does not have browser support.
 
 ## Help
 

examples/javascript/filestorage.js

@@ -20,7 +20,7 @@ const provider = new common.ConfigFileAuthenticationDetailsProvider(
 );
 
 /**
- * This file provides an example of how to use the File Storage service in the SDK for Typescript.
+ * This file provides an example of how to use the File Storage service in the SDK for TypeScript.
  *
  * In order to demonstrate functionality for mount targets and export sets, this script will also create a VCN
  * and subnet. These will be deleted at the end of the script. This script also makes some assumptions about

examples/javascript/identity.js

@@ -37,7 +37,7 @@ const tenancyId = {
   const userDetails = {
     compartmentId: provider.getTenantId() || "",
     name: userName,
-    description: "Created by a SDK for Typescript example"
+    description: "Created by a SDK for TypeScript example"
   };
 
   const userReq = {
@@ -52,7 +52,7 @@ const tenancyId = {
   const groupDetails = {
     compartmentId: provider.getTenantId() || "",
     name: groupName,
-    description: "Created by a SDK for Typescript example"
+    description: "Created by a SDK for TypeScript example"
   };
 
   const groupReq = {

examples/javascript/invoke-function.js

@@ -17,7 +17,7 @@ const provider = new common.ConfigFileAuthenticationDetailsProvider(
 );
 /**
  * This is a basic example of how to register and invoke a serverless Function
- * on OCI using the SDK for Typescript.
+ * on OCI using the SDK for TypeScript.
  *
  * The example has some pre-requisites. In particular you will need to create a
  * Function and publish it to OCIR. The best way to do this is with the 'Fn

examples/javascript/monitoring-alarm.js

@@ -14,7 +14,7 @@ const provider = new common.ConfigFileAuthenticationDetailsProvider(
   configProfile
 );
 /**
- * This class demonstrates how to use the Monitoring api in the SDK for Typescript. This will cover:
+ * This class demonstrates how to use the Monitoring api in the SDK for TypeScript. This will cover:
  *
  * <ul>
  *   <li>Creating, updating, retrieving, listing and deleting alarms</li>
@@ -35,7 +35,7 @@ const provider = new common.ConfigFileAuthenticationDetailsProvider(
  * <ul>
  */
 
-const DISPLAY_NAME = "Alarm for SDK for Typescript sample";
+const DISPLAY_NAME = "Alarm for SDK for TypeScript sample";
 const NAME_SPACE = "oci_computeagent";
 const METRIC_QUERY = "CpuUtilization[1m].max() > 75";
 const RESOLUTION = "1m";

examples/javascript/tagging.js

@@ -25,7 +25,7 @@ const provider = new common.ConfigFileAuthenticationDetailsProvider(
   const namespace = {
     compartmentId: compartmentId,
     name: `typeScriptExample_namespace${Math.floor(Math.random() * Math.floor(1000000))}`,
-    description: "SDK for Typescript example tag namespace"
+    description: "SDK for TypeScript example tag namespace"
   };
   const namespaceReq = {
     createTagNamespaceDetails: namespace
@@ -37,7 +37,7 @@ const provider = new common.ConfigFileAuthenticationDetailsProvider(
   // Create a tag one
   const tagOneName = {
     name: "typeScriptExample_tagOne",
-    description: "SDK for Typescript example tag one"
+    description: "SDK for TypeScript example tag one"
   };
 
   const createTagOneReq = {
@@ -50,7 +50,7 @@ const provider = new common.ConfigFileAuthenticationDetailsProvider(
   // Create another tag
   const tagTwoName = {
     name: "typeScriptExample_tagTwo",
-    description: "SDK for Typescript example tag two"
+    description: "SDK for TypeScript example tag two"
   };
 
   const createTagTwoReq = {
@@ -124,7 +124,7 @@ const provider = new common.ConfigFileAuthenticationDetailsProvider(
       const createVCNDetails = {
         cidrBlock: "10.0.0.0/16",
         compartmentId: compartmentId,
-        displayName: "SDK for Typescript tagging example VCN",
+        displayName: "SDK for TypeScript tagging example VCN",
         dnsLabel: `vcn${Math.floor(Math.random() * Math.floor(1000000))}`,
         freeformTags: { "free": "form", "another": "item" },
         definedTags: {

examples/typescript/containerengine-node-pool.ts

@@ -17,7 +17,7 @@ const provider: common.ConfigFileAuthenticationDetailsProvider = new common.Conf
   configProfile
 );
 /**
- * This class provides an example of how to create a Container Engine node pool in the SDK for Typescript.
+ * This class provides an example of how to create a Container Engine node pool in the SDK for TypeScript.
  * It will create a VCN and three subnets, one Container Engine cluster and add one node pool in the cluster.
  * These will be deleted at the end. The class also makes some assumptions about
  * the resources it will create:

examples/typescript/filestorage.ts

@@ -20,7 +20,7 @@ const provider: common.ConfigFileAuthenticationDetailsProvider = new common.Conf
 );
 
 /**
- * This file provides an example of how to use the File Storage service in the SDK for Typescript.
+ * This file provides an example of how to use the File Storage service in the SDK for TypeScript.
  *
  * In order to demonstrate functionality for mount targets and export sets, this script will also create a VCN
  * and subnet. These will be deleted at the end of the script. This script also makes some assumptions about

examples/typescript/identity.ts

@@ -20,13 +20,7 @@ const provider: common.ConfigFileAuthenticationDetailsProvider = new common.Conf
   configProfile
 );
 
-const profile = config.accumulator.configurationsByProfile.get("DEFAULT");
-let tenancy = "";
-if (profile) {
-  tenancy = profile.get("tenancy") as string;
-} else {
-  tenancy = "";
-}
+const tenancy = provider.getTenantId();
 const tenancyId: identity.requests.ListRegionSubscriptionsRequest = {
   tenancyId: tenancy || ""
 };
@@ -48,7 +42,7 @@ const tenancyId: identity.requests.ListRegionSubscriptionsRequest = {
   const userDetails: identity.models.CreateUserDetails = {
     compartmentId: tenancy,
     name: userName,
-    description: "Created by a SDK for Typescript example"
+    description: "Created by a SDK for TypeScript example"
   };
 
   const userReq: identity.requests.CreateUserRequest = {
@@ -63,7 +57,7 @@ const tenancyId: identity.requests.ListRegionSubscriptionsRequest = {
   const groupDetails: identity.models.CreateGroupDetails = {
     compartmentId: tenancy,
     name: groupName,
-    description: "Created by a SDK for Typescript example"
+    description: "Created by a SDK for TypeScript example"
   };
 
   const groupReq: identity.requests.CreateGroupRequest = {

examples/typescript/invoke-function.ts

@@ -18,7 +18,7 @@ const provider: common.ConfigFileAuthenticationDetailsProvider = new common.Conf
 
 /**
  * This is a basic example of how to register and invoke a serverless Function
- * on OCI using the SDK for Typescript.
+ * on OCI using the SDK for TypeScript.
  *
  * The example has some pre-requisites. In particular you will need to create a
  * Function and publish it to OCIR. The best way to do this is with the 'Fn

examples/typescript/logging.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) 2020, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+  
+  This is an example shows how to integrate a logger with the SDK
+ */
+
+var oci = require("oci-sdk");
+var bunyan = require("bunyan");
+
+// Integrate bunyan logger with the SDK. Make sure bunyan logger in installed.
+// You can integrate with log4js, winston or any other logger as well.
+var bunLog = bunyan.createLogger({ name: "LoggingExample", level: "debug" });
+oci.LOG.logger = bunLog;
+
+const configurationFilePath = "~/.oci/config";
+const configProfile = "DEFAULT";
+
+const provider = new oci.ConfigFileAuthenticationDetailsProvider(
+  configurationFilePath,
+  configProfile
+);
+
+const tenancyId = {
+  tenancyId: provider.getTenantId() || ""
+};
+
+(async () => {
+  const identityClient = new oci.identity.IdentityClient({
+    authenticationDetailsProvider: provider
+  });
+  const regions = await identityClient.listRegionSubscriptions(tenancyId);
+  for (let i = 0; i < regions.items.length; i++) {
+    console.log(`Region fetched ${regions.items[i].regionName}`);
+  }
+})();

examples/typescript/monitoring-alarm.ts

@@ -14,7 +14,7 @@ const provider: common.ConfigFileAuthenticationDetailsProvider = new common.Conf
   configProfile
 );
 /**
- * This class demonstrates how to use the Monitoring api in the SDK for Typescript. This will cover:
+ * This class demonstrates how to use the Monitoring api in the SDK for TypeScript. This will cover:
  *
  * <ul>
  *   <li>Creating, updating, retrieving, listing and deleting alarms</li>
@@ -35,7 +35,7 @@ const provider: common.ConfigFileAuthenticationDetailsProvider = new common.Conf
  * <ul>
  */
 
-const DISPLAY_NAME: string = "Alarm for SDK for Typescript sample";
+const DISPLAY_NAME: string = "Alarm for SDK for TypeScript sample";
 const NAME_SPACE: string = "oci_computeagent";
 const METRIC_QUERY: string = "CpuUtilization[1m].max() > 75";
 const RESOLUTION: string = "1m";

examples/typescript/move-compartment.ts

@@ -12,7 +12,6 @@
 */
 
 import * as identity from "oci-identity";
-import { ConfigFileReader } from "oci-common/lib/config-file-reader";
 import common = require("oci-common");
 
 const configurationFilePath = "~/.oci/config";
@@ -22,14 +21,7 @@ const provider: common.ConfigFileAuthenticationDetailsProvider = new common.Conf
   configurationFilePath,
   configProfile
 );
-const config = ConfigFileReader.parseDefault(null);
-const profile = config.accumulator.configurationsByProfile.get("DEFAULT");
-let compartmentId = "";
-if (profile) {
-  compartmentId = profile.get("tenancy") as string;
-} else {
-  compartmentId = "";
-}
+const compartmentId = provider.getTenantId();
 
 (async () => {
   const identityClient = new identity.IdentityClient({ authenticationDetailsProvider: provider });

examples/typescript/pagination.ts

@@ -5,28 +5,16 @@
 
 import common = require("oci-common");
 import * as identity from "oci-identity";
-import {
-  paginateRecords,
-  paginateResponses,
-  paginatedRecordsWithLimit,
-  paginatedResponsesWithLimit
-} from "oci-common/lib/paginators";
-import { ConfigFileReader } from "oci-common/lib/config-file-reader";
+import { paginatedRecordsWithLimit, paginatedResponsesWithLimit } from "oci-common/lib/paginators";
+
 const configurationFilePath = "~/.oci/config";
 const configProfile = "DEFAULT";
 
 const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider(
   configurationFilePath,
   configProfile
 );
-const config = ConfigFileReader.parseDefault(null);
-const profile = config.accumulator.configurationsByProfile.get("DEFAULT");
-let compartmentId = "";
-if (profile) {
-  compartmentId = profile.get("tenancy") as string;
-} else {
-  compartmentId = "";
-}
+const compartmentId = provider.getTenantId();
 
 (async () => {
   const identityClient = new identity.IdentityClient({ authenticationDetailsProvider: provider });