neotek / Picturepark.SDK.TypeScript

Our Typescript SDK contains HTML 5 Fetch and Angular service classes for access to the Picturepark API. The Angular SDK has ready-made UI Components based on Angular Material for easy reuse in your projects or as a reference to how a custom UI for accessing and managing Picturepark content can be built. A sample “Content Picker” application showcases how all components work together and details how to implement authentication. Furthermore, the “Content Picker” can be used to select existing assets when integrated into third party applications. The widgets project features components to embed Picturepark content into other websites, including support for players (Image slider, Video and Audio playback and Document viewer)

Picturepark Content Platform TypeScript/JavaScript SDK

Picturepark.Sdk.TypeScript

Links:

• Picturepark Website
• Available NPM packages
• Sources

Projects

picturepark-sdk-v1-angular

Contains Angular service classes to access the Picturepark API.

NPM package: @picturepark/sdk-v1-angular

picturepark-sdk-v1-angular-oidc

Contains Angular service classes to access the Picturepark authentication endpoints.

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

picturepark-sdk-v1-angular-ui

Contains Angular UI components based on Angular Material.

NPM package: @picturepark/sdk-v1-angular-ui

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

picturepark-sdk-v1-widgets

Contains widgets to embed Picturepark content into other websites.

Compatibility matrix

SDK version	Picturepark CP version
11.0.x	11.0.x
11.1.x	11.1.x
11.2.x	11.2.x
11.3.x	11.3.x

SDK Development

Links:

• Build scripts
• Sources

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.

After nswag was run, manually revert change for removed block: import { ... } from './api-services'; from auto generated file: src\picturepark-sdk-v1-angular\projects\picturepark-sdk-v1-angular\src\lib\services\frontend-services.ts

Release new package versions

1. Change package versions in the following projects and delete all package-lock.json files:

• picturepark-sdk-v1-angular
• picturepark-sdk-v1-angular-oidc
• picturepark-sdk-v1-angular-ui
• picturepark-sdk-v1-fetch
• picturepark-sdk-v1-pickers

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

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

   npm run build

3. 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

• AppVeyor CI Build: Picturepark.SDK.TypeScript CI

Pre-Release Builds

Branch: pre-release

• NPM Feed: https://www.npmjs.com/~picturepark
• AppVeyor Build: Picturepark.SDK.TypeScript PRE

Release Builds

Branch: release

• NPM Feed: https://www.npmjs.com/~picturepark
• AppVeyor Build: Picturepark.SDK.TypeScript