@cognite/sdk-beta - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -6,4 +6,15 @@ # Change Log
 
+## [1.0.1](https://github.com/cognitedata/cognite-sdk-js/compare/@cognite/sdk-beta@1.0.0...@cognite/sdk-beta@1.0.1) (2020-09-10)
+
+
+### Bug Fixes
+
+* exports from packages, add guide for making derived SDKs ([#421](https://github.com/cognitedata/cognite-sdk-js/issues/421)) ([a3a2eb0](https://github.com/cognitedata/cognite-sdk-js/commit/a3a2eb03645733c289591b187f19e55b5294fbc7))
+
+
+
+
+
 # 1.0.0 (2020-08-03)
 
-**Note:** Version bump only for package @cognite/sdk-beta
+ * creation of beta sdk

dist/index.js

@@ -36,6 +36,13 @@ 'use strict';
 
-var version="1.0.0";
+var version="1.0.1";
 
-var CogniteClientBeta = /** @class */ (function (_super) {
-    __extends(CogniteClientBeta, _super);
+var CogniteClientCleaned = /** @class */ (function (_super) {
+    __extends(CogniteClientCleaned, _super);
+    function CogniteClientCleaned() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return CogniteClientCleaned;
+}(sdk.CogniteClient));
+var CogniteClient = /** @class */ (function (_super) {
+    __extends(CogniteClient, _super);
     /**
@@ -58,6 +65,6 @@ * Create a new SDK client (beta)
      */
-    function CogniteClientBeta(options) {
+    function CogniteClient(options) {
         return _super.call(this, options) || this;
     }
-    Object.defineProperty(CogniteClientBeta.prototype, "version", {
+    Object.defineProperty(CogniteClient.prototype, "version", {
         get: function () {
@@ -69,4 +76,4 @@ return version + "-beta";
     });
-    return CogniteClientBeta;
-}(sdk.CogniteClient));
+    return CogniteClient;
+}(CogniteClientCleaned));
 
@@ -81,3 +88,3 @@ Object.keys(sdk).forEach(function (k) {
 });
-exports.CogniteClient = CogniteClientBeta;
+exports.CogniteClient = CogniteClient;
 //# sourceMappingURL=index.js.map

dist/src/cogniteClient.d.ts

 import { ClientOptions, CogniteClient as CogniteClientStable } from '@cognite/sdk';
-export default class CogniteClientBeta extends CogniteClientStable {
+declare class CogniteClientCleaned extends CogniteClientStable {
+}
+export default class CogniteClient extends CogniteClientCleaned {
     /**
@@ -23,2 +25,2 @@ * Create a new SDK client (beta)
 }
-export * from '@cognite/sdk';
+export {};

dist/src/index.d.ts

 export * from '@cognite/sdk';
-export * from './types';
 export { default as CogniteClient } from './cogniteClient';

package.json

@@ -9,3 +9,3 @@ {
   "types": "dist/src/index.d.js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "scripts": {
@@ -19,4 +19,5 @@ "clean": "rm -rf dist/ docs/ codeSnippets/",
     "watch": "rollup -cw",
+    "esCheck": "es-check es5 './dist/index.js'",
     "docs": "typedoc --options typedoc.js --tsconfig tsconfig.json src/index.ts",
-    "esCheck": "es-check es5 './dist/index.js'",
+    "docs:bundle": "yarn docs && mkdir -p ../../docs/beta && cp -r docs/* ../../docs/beta/",
     "extract-snippets": "rm -rf codeSnippets/ && yarn docs --json codeSnippets/docs.json && node ../../scripts/extractCodeSnippets.js",
@@ -26,4 +27,4 @@ "test-snippets": "yarn extract-snippets && yarn tsc -p codeSnippets/tsconfig.build.json"
   "dependencies": {
-    "@cognite/sdk": "^3.0.0",
-    "@cognite/sdk-core": "^1.0.0"
+    "@cognite/sdk": "^3.1.0",
+    "@cognite/sdk-core": "^1.0.1"
   },
@@ -33,3 +34,3 @@ "publishConfig": {
   },
-  "gitHead": "e04804beedf85025df40d0e57519bbb103b66717"
+  "gitHead": "c141e83378de59346e4c3288d9cba8a0d848186f"
 }

README.md

@@ -7,7 +7,7 @@ Cognite Javascript SDK beta
 ```
-$ yarn add @cognite/sdk@npm:@cognite/sdk-beta
+yarn add @cognite/sdk@npm:@cognite/sdk-beta
 ```
 or with npm
 ```
-$ npm install @cognite/sdk@npm:@cognite/sdk-beta --save
+npm install @cognite/sdk@npm:@cognite/sdk-beta --save
 ```
@@ -30,5 +30,4 @@
 
-When you import `CogniteClient` from the beta sdk, you will in reality get the subclass `CogniteClientBeta`.
-See the reference doc [here](https://cognitedata.github.io/cognite-sdk-js/beta/classes/cogniteclientbeta.html).
+See the reference doc of `CogniteClient` [here](https://cognitedata.github.io/cognite-sdk-js/beta/classes/cogniteclientbeta.html).
 
 The beta API is mostly a superset of stable. See the [stable readme](https://github.com/cognitedata/cognite-sdk-js/blob/master/packages/stable/README.md).

src/cogniteClient.ts

@@ -8,3 +8,7 @@ // Copyright 2020 Cognite AS
 
-export default class CogniteClientBeta extends CogniteClientStable {
+class CogniteClientCleaned extends CogniteClientStable {
+  // Remove type restrictions
+}
+
+export default class CogniteClient extends CogniteClientCleaned {
   /**
@@ -35,3 +39,1 @@ * Create a new SDK client (beta)
 }
-
-export * from '@cognite/sdk';

src/index.ts

 // Copyright 2020 Cognite AS
 
 export * from '@cognite/sdk';
-export * from './types';
 export { default as CogniteClient } from './cogniteClient';

src/types.ts

 // Copyright 2020 Cognite AS
 
 export * from '@cognite/sdk';
+// This file is here mostly to allow apis to import { ... } from '../../types';
+// Overriding types should probably be done in their respective API endpoint files, where possible

typedoc.js

 module.exports = {
-  name: 'Cognite JavaScript SDK',
-  mode: 'file',
+  name: 'Cognite JavaScript SDK (beta)',
+
+  // Stable and core use 'file' mode, which makes reference pages based on the names of classes and types.
+  // Derived SDKs usually re-definine classes using the same name, which breaks in file mode.
+  // 'modules' mode makes the file path part of the url, which allows classes with overlapping
+  // names across packages.
+  mode: 'modules',
   module: 'umd',
@@ -10,3 +15,3 @@ target: 'ES6',
   ignoreCompilerErrors: true,
-  excludeNotExported: true,
+  excludeNotExported: false,
   hideGenerator: true,
@@ -13,0 +18,0 @@ excludePrivate: true,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

34135

increased by3.78%

Lines of code

249

increased by6.41%

Worsened metrics

Number of lines in readme file

31

decreased by-3.12%

Dependency changes

• + Addeddunder-proto@1.0.0(transitive)

• - Removeddunder-proto@1.0.1(transitive)

• Updated@cognite/sdk@^3.1.0

• Updated@cognite/sdk-core@^1.0.1