@ridi/cms-sdk - npm Package Compare versions

Comparing version 2.0.1 to 2.1.0

CHANGELOG.md

@@ -0,9 +1,15 @@
+# Ridibooks CMS SDK
+
+## 2.1 (2018-02-13)
+
+- [PHP] **Remove** deprecated method `AdminAuthService::getAdminTag`
+- [Node.js] Support Node.js
+- [Python] Support Python
+- Use token-based Login
+- Remove session server depenency
+
 ## 2.0 (2017-08-17)
 
-#### BREAKING CHANGES
-- Namespace change not to include `\Platform`
+### BREAKING CHANGES
 
-## 2.1 (???)
-
-#### Features
-- Support Node.js
+- [PHP] Namespace change not to include `\Platform`

lib/js/dist/index.js

@@ -6,3 +6,3 @@ 'use strict';
 });
-exports.CmsSession = exports.CmsSdk = undefined;
+exports.LoginSession = exports.CmsSdk = undefined;
 
@@ -13,5 +13,5 @@ var _CmsSdk = require('./CmsSdk');
 
-var _CmsSession = require('./Session/CmsSession');
+var _LoginSession = require('./LoginSession');
 
-var _CmsSession2 = _interopRequireDefault(_CmsSession);
+var _LoginSession2 = _interopRequireDefault(_LoginSession);
 
@@ -21,2 +21,2 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 exports.CmsSdk = _CmsSdk2.default;
-exports.CmsSession = _CmsSession2.default;
+exports.LoginSession = _LoginSession2.default;

lib/js/lib/index.js

 import CmsSdk from './CmsSdk';
-import CmsSession from './Session/CmsSession';
+import LoginSession from './LoginSession';
 
-export { CmsSdk, CmsSession };
+export { CmsSdk, LoginSession };

lib/js/README.md

@@ -47,1 +47,3 @@ # Ridibooks CMS SDK - javascript
 ```
+
+Check out our [sample project](https://github.com/ridi/cms-bootstrap-js) for more details.

package.json

 {
   "name": "@ridi/cms-sdk",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Ridibooks CMS SDK",
@@ -15,3 +15,3 @@ "main": "./lib/js/dist/index.js",
     "babel-loader": "^7.1.2",
-    "babel-preset-env": "^1.6.0",
+    "babel-preset-env": "^1.6.1",
     "babel-preset-react": "^6.24.1",
@@ -28,3 +28,3 @@ "chai": "^4.1.2",
     "url-loader": "^0.5.9",
-    "webpack": "^3.6.0",
+    "webpack": "^3.11.0",
     "webpack-manifest-plugin": "^1.3.2"
@@ -31,0 +31,0 @@ },

README.md

 # Ridibooks CMS SDK
+
 [![Packagist](https://img.shields.io/packagist/v/ridibooks/cms-sdk.svg)](https://packagist.org/packages/ridibooks/cms-sdk)
 
 ## Introduction
+
 CMS SDK provides common resources used in RIDI CMS
-- RPC Client code to communicate with CMS auth server
-- Common twig templates
-
 This library uses [Apache Thrift](https://thrift.apache.org) for a RPC implementation.
 
-## Hierarchy
-```
-cms-sdk/
-├── src/
-│   ├── (...)          # Wrapping classes which uses thrift client inside.
-│   │
-│   └── Thrift/
-│        ├── (...)     # PHP codes generated by Thrift source.
-│        └── *.thrift  # Thrift source to communicate with CMS Auth server.
-│
-├── views/
-│   └── *.twig         # Common twig templates
-...
-```
+## Supporting Languages
 
-## Dependencies
-To make RPC client, you should install Apache Thrift.
-```
+For more details, see below links.
+
+- [PHP](./lib/php/README.md)
+- [JS](./lib/js/README.md)
+- [Python](./lib/python/README.md)
+
+## For SDK developers
+
+To build a RPC client, you should install Apache Thrift.
+
+``` sh
 # In OSX, you can install easily with homebrew.
@@ -33,10 +27,16 @@ brew install thrift
 
-## Generate code
 To generate thrift code, please run:
-```
+
+``` sh
 make thrift
 ```
 
-## Usage
-- [PHP](./lib/php/README.md)
-- [Javascript](./lib/javascript/README.md)
+### CMS-SDK Release steps
+
+1. Create `release/{version}` branch.
+1. Update `CHANGELOG.md`.
+1. Update new SDK version in `package.json` & `lib/python/setup.py`.
+1. Commit & push all the changes and make a pull request.
+1. After PR, tag a new release in github. This will release a new version in Packagist.
+1. `make -C lib/js release` will release js module.
+1. `make -C lib/python release` will release python package.

No alert changes

Worsened metrics

Total package byte prevSize

401654

decreased by-0.31%

Number of package files

32

decreased by-3.03%

Lines of code

12026

decreased by-0.3%

No dependency changes