Links:
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
Contains Angular UI components based on Angular Material.
NPM package: @picturepark/sdk-v1-angular-ui
Contains client classes to access the Picturepark API with window.fetch
.
NPM package: @picturepark/sdk-v1-fetch
Provides functions to show a content picker to select existing assets in 3rd party applications.
NPM package: @picturepark/sdk-v1-pickers
Contains widgets to embed Picturepark content into other websites.
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:
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
- 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
-
Run the following command to regenerate the
package-lock.json
files and build all projects:npm run build
-
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
Branch: master
- AppVeyor CI Build: Picturepark.SDK.TypeScript CI
Branch: pre-release
- NPM Feed: https://www.npmjs.com/~picturepark
- AppVeyor Build: Picturepark.SDK.TypeScript PRE
Branch: release
- NPM Feed: https://www.npmjs.com/~picturepark
- AppVeyor Build: Picturepark.SDK.TypeScript