Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,34 @@
# Picturepark Content Platform TypeScript/JavaScript SDK
# Fotoware Alto TypeScript/JavaScript SDK

> **Note:** The platform has been renamed from Picturepark Content Platform to **Fotoware Alto**, but the project name remains **Picturepark**. You may encounter both names in documentation, code, and resources.

## Picturepark.Sdk.TypeScript

[![npm](https://img.shields.io/npm/v/@picturepark/sdk-v2-angular.svg)](https://www.npmjs.com/~picturepark)

Links:

- [Picturepark Website](https://picturepark.com/)
- [Fotoware Website](https://picturepark.com/)
- [Available NPM packages](https://www.npmjs.com/~picturepark)
- [Sources](src/)

## Projects

**[picturepark-sdk-v2-angular](docs/picturepark-sdk-v2-angular/README.md)**

Contains Angular service classes to access the Picturepark API.
Contains Angular service classes to access the Fotoware Alto API.

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

**[picturepark-sdk-v2-angular-oidc](docs/picturepark-sdk-v2-angular/README.md)**

Contains Angular service classes to access the Picturepark authentication endpoints.
Contains Angular service classes to access the Fotoware Alto authentication endpoints.

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

**[picturepark-sdk-v1-fetch](docs/picturepark-sdk-v1-fetch/README.md)**

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

NPM package: `@picturepark/sdk-v1-fetch`

Expand All @@ -37,13 +40,14 @@ NPM package: `@picturepark/sdk-v1-pickers`

## Compatibility matrix

| SDK version | Picturepark CP version | Branch |
| SDK version | Fotoware Alto version | Branch |
| ----------- | ---------------------- | -----------
| `11.12.x` | `11.12.x` | [11.12.x](https://github.com/Picturepark/Picturepark.SDK.TypeScript/tree/11.12.x)
| `11.13.x` | `11.13.x` | [11.13.x](https://github.com/Picturepark/Picturepark.SDK.TypeScript/tree/11.13.x)
| `11.14.x` | `11.14.x` | [11.14.x](https://github.com/Picturepark/Picturepark.SDK.TypeScript/tree/11.14.x)
| `11.15.x` | `11.15.x` | [11.15.x](https://github.com/Picturepark/Picturepark.SDK.TypeScript/tree/11.15.x)
| `11.16.x` | `11.16.x` | [master](https://github.com/Picturepark/Picturepark.SDK.TypeScript/tree/master)
| `11.16.x` | `11.16.x` | [11.16.x](https://github.com/Picturepark/Picturepark.SDK.TypeScript/tree/11.16.x)
| `11.17.x` | `11.17.x` | [master](https://github.com/Picturepark/Picturepark.SDK.TypeScript/tree/master)

SDK Development

Expand Down
2 changes: 1 addition & 1 deletion build/build-docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const rootDir = path.resolve(__dirname, '../');
const runTypeDoc = (src, tsconfig, out, readme, name) => {
const typedocPath = path.resolve(rootDir, 'node_modules', '.bin', 'typedoc');

const cmd = `"${typedocPath}" "${src}" --tsconfig "${tsconfig}" --out "${out}" --readme "${readme}" --theme default --name "${name}"`;
const cmd = `"${typedocPath}" "${src}" --tsconfig "${tsconfig}" --out "${out}" --readme "${readme}" --theme default --name "${name}" --gitRemote "origin" --gitRevision "master"`;
execSync(cmd, { stdio: 'inherit' });
};

Expand Down
8 changes: 4 additions & 4 deletions docs/picturepark-sdk-v1-fetch/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Picturepark Content Platform TypeScript SDK: Fetch Clients
# Fotoware Alto TypeScript SDK: Fetch Clients

## picturepark-sdk-v1-fetch

**NPM Package:** [@picturepark/sdk-v1-fetch](https://www.npmjs.com/package/@picturepark/sdk-v1-fetch)

The `@picturepark/sdk-v1-fetch` NPM package provides client classes to access the Picturepark API by using the `window.fetch` APIs. These are common APIs which are present in modern browsers. The library is suitable for all web applications (e.g. React/Redux, JQuery, Vanilla.JS, etc.) but offers only the service clients and no controls/components.
The `@picturepark/sdk-v1-fetch` NPM package provides client classes to access the Fotoware Alto API by using the `window.fetch` APIs. These are common APIs which are present in modern browsers. The library is suitable for all web applications (e.g. React/Redux, JQuery, Vanilla.JS, etc.) but offers only the service clients and no controls/components.

- [API Documentation](https://rawgit.com/Picturepark/Picturepark.SDK.TypeScript/master/docs/picturepark-sdk-v1-fetch/api/index.html)

Expand Down Expand Up @@ -89,7 +89,7 @@ let authClient = new AuthClient(server, customerAlias);

**AccessTokenAuthClient**

Token based authentication to access the Picturepark API
Token based authentication to access the Fotoware Alto API

```js
let authClient = new AccessTokenAuthClient(server, customerAlias, accessToken);
Expand All @@ -103,7 +103,7 @@ For authenticating with the OIDC implicit flow, you can use the JavaScript libra
npm install oidc-client
```

For this sample, import the Picturepark OIDC settings helper `OidcClientSettings`, the `AccessTokenAuthClient`, `ContentClient` and the oidc-client `UserManager` classes:
For this sample, import the Fotoware Alto OIDC settings helper `OidcClientSettings`, the `AccessTokenAuthClient`, `ContentClient` and the oidc-client `UserManager` classes:

```js
import { OidcClientSettings, AccessTokenAuthClient, ContentClient } from '@picturepark/sdk-v1-fetch';
Expand Down

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/picturepark-sdk-v1-fetch/api/classes/AuthClient.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/picturepark-sdk-v1-fetch/api/classes/ChannelClient.html

Large diffs are not rendered by default.

96 changes: 48 additions & 48 deletions docs/picturepark-sdk-v1-fetch/api/classes/ContentClient.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/picturepark-sdk-v1-fetch/api/classes/InfoClient.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/picturepark-sdk-v1-fetch/api/classes/IngestClient.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

38 changes: 19 additions & 19 deletions docs/picturepark-sdk-v1-fetch/api/classes/ListItemClient.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/picturepark-sdk-v1-fetch/api/classes/MetadataClient.html

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/picturepark-sdk-v1-fetch/api/classes/NotificationClient.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/picturepark-sdk-v1-fetch/api/classes/OutputClient.html

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions docs/picturepark-sdk-v1-fetch/api/classes/OutputFormatClient.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/picturepark-sdk-v1-fetch/api/classes/ProfileClient.html

Large diffs are not rendered by default.

42 changes: 21 additions & 21 deletions docs/picturepark-sdk-v1-fetch/api/classes/SchemaClient.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

36 changes: 18 additions & 18 deletions docs/picturepark-sdk-v1-fetch/api/classes/ShareClient.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/picturepark-sdk-v1-fetch/api/classes/StatisticClient.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/picturepark-sdk-v1-fetch/api/classes/TemplateClient.html

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions docs/picturepark-sdk-v1-fetch/api/classes/TransferClient.html

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions docs/picturepark-sdk-v1-fetch/api/classes/UserClient.html

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions docs/picturepark-sdk-v1-fetch/api/classes/UserRoleClient.html

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions docs/picturepark-sdk-v1-fetch/api/classes/XmpMappingClient.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/picturepark-sdk-v1-fetch/api/enums/AlphaHandling.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/picturepark-sdk-v1-fetch/api/enums/Analyzer.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Loading