Skip to content

Latest commit

 

History

History
96 lines (57 loc) · 3.07 KB

README.md

File metadata and controls

96 lines (57 loc) · 3.07 KB
Raw

Picturepark Content Platform TypeScript/JavaScript SDK

Picturepark.Sdk.TypeScript

npm

Links:

Projects

picturepark-sdk-v2-angular

Contains Angular service classes to access the Picturepark API.

NPM package: @picturepark/sdk-v2-angular

picturepark-sdk-v2-angular-oidc

Contains Angular service classes to access the Picturepark authentication endpoints.

NPM package: @picturepark/sdk-v2-angular-oidc

picturepark-sdk-v1-fetch

Contains client classes to access the Picturepark API with window.fetch.

NPM package: @picturepark/sdk-v1-fetch

picturepark-sdk-v1-pickers

Provides functions to show a content picker to select existing assets in 3rd party applications.

NPM package: @picturepark/sdk-v1-pickers

Compatibility matrix

SDK version Picturepark CP version Branch
11.12.x 11.12.x 11.12.x
11.13.x 11.13.x 11.13.x
11.14.x 11.14.x master

SDK Development

Links:

Regenerate clients from Swagger specification

Run the following commands to regenerate the clients based on the Swagger specifications in /swagger:

npm install
npm run nswag

For more information, see NSwag.

Release new package versions

  1. Change package versions in the following projects and delete all package-lock.json files:
  • picturepark-sdk-v2-angular
  • picturepark-sdk-v2-angular-oidc
  • picturepark-sdk-v1-fetch
  • picturepark-sdk-v1-pickers

NOTE:
For pre-release packages, the version should include the "pre" identifier.
Ex: 11.13.0-pre.0

  1. Run the following command to regenerate the package-lock.json files and build all projects:

    npm run build

  2. Commit and push changes, then merge into the "pre-release" or "release" branch. The NPM packages are now automatically published by AppVeyor.

NOTE:
"pre-release - to generate pre-release packages
"release" - to generate release packages

CI Builds

Branch: master

Release Builds

Branch: release