@axinom/mosaic-managed-workflow-integration 0.17.0-rc.0 → 0.17.0-rc.2

package/dist/video/video-cue-points.d.ts

@@ -1,4 +1,3 @@
-import { PiletApi } from '@axinom/mosaic-portal';
 import { ID, Maybe } from '../common';
 import { EncodingState } from './types';
 export interface VideoServiceCuePoints {
@@ -16,10 +15,11 @@ export interface VideoData {
         nodes: VideoServiceCuePoints[];
     };
 }
-export declare let getVideoCuePointsData: () => (id: ID[], cuePointTypeKeys?: string[]) => Promise<VideoData[]>;
 /**
- * Initializes the video-cue-points-data function.
- * @param app The PiletApi object.
+ * Returns the video cue points data for the given video IDs.
+ * This method depends on the `initializeIntegrationLib` function being called before.
+ * @param id The video IDs for which to fetch the cue points data.
+ * @param cuePointTypeKeys Optional array of cue point type keys that will be used as filter for the returend cue points. If not set, will return all cue points.
  */
-export declare function setGetVideoCuePointsData(app: PiletApi): void;
+export declare const getVideoCuePointsData: (id: ID[], cuePointTypeKeys?: string[]) => Promise<VideoData[]>;
 //# sourceMappingURL=video-cue-points.d.ts.map

package/dist/video/video-cue-points.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"video-cue-points.d.ts","sourceRoot":"","sources":["../../src/video/video-cue-points.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,EAAE,EAAE,EAAE,CAAC;IACP,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,EAAE,EAAE,EAAE,CAAC;IACP,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAChC,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,EAAE;QACT,UAAU,CAAC,EAAE,qBAAqB,CAAC;QACnC,KAAK,EAAE,qBAAqB,EAAE,CAAC;KAChC,CAAC;CACH;AAED,eAAO,IAAI,qBAAqB,EAAE,MAAM,CACtC,EAAE,EAAE,EAAE,EAAE,EACR,gBAAgB,CAAC,EAAE,MAAM,EAAE,KACxB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;AAE1B;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI,CAE5D"}
+{"version":3,"file":"video-cue-points.d.ts","sourceRoot":"","sources":["../../src/video/video-cue-points.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,MAAM,WAAW,qBAAqB;IACpC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,EAAE,EAAE,EAAE,CAAC;IACP,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,EAAE,EAAE,EAAE,CAAC;IACP,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAChC,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,EAAE;QACT,UAAU,CAAC,EAAE,qBAAqB,CAAC;QACnC,KAAK,EAAE,qBAAqB,EAAE,CAAC;KAChC,CAAC;CACH;AAED;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,EAAE,CAClC,EAAE,EAAE,EAAE,EAAE,EACR,gBAAgB,CAAC,EAAE,MAAM,EAAE,KACxB,OAAO,CAAC,SAAS,EAAE,CAQvB,CAAC"}

package/dist/video/video-cue-points.js

@@ -1,12 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setGetVideoCuePointsData = exports.getVideoCuePointsData = void 0;
+exports.getVideoCuePointsData = void 0;
+const initialize_1 = require("../initialize");
 /**
- * Initializes the video-cue-points-data function.
- * @param app The PiletApi object.
+ * Returns the video cue points data for the given video IDs.
+ * This method depends on the `initializeIntegrationLib` function being called before.
+ * @param id The video IDs for which to fetch the cue points data.
+ * @param cuePointTypeKeys Optional array of cue point type keys that will be used as filter for the returend cue points. If not set, will return all cue points.
  */
-function setGetVideoCuePointsData(app) {
-    exports.getVideoCuePointsData = () => app.getData('video-cue-points-data');
-}
-exports.setGetVideoCuePointsData = setGetVideoCuePointsData;
+const getVideoCuePointsData = (id, cuePointTypeKeys) => {
+    if (initialize_1.piletApi === undefined) {
+        throw new Error('The pilet API is not initialized. Please call `initializeIntegrationLib` before using this function.');
+    }
+    return initialize_1.piletApi.getData('video-cue-points-data')(id, cuePointTypeKeys);
+};
+exports.getVideoCuePointsData = getVideoCuePointsData;
 //# sourceMappingURL=video-cue-points.js.map

package/dist/video/video-cue-points.js.map

@@ -1 +1 @@
-{"version":3,"file":"video-cue-points.js","sourceRoot":"","sources":["../../src/video/video-cue-points.ts"],"names":[],"mappings":";;;AA0BA;;;GAGG;AACH,SAAgB,wBAAwB,CAAC,GAAa;IACpD,6BAAqB,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;AACrE,CAAC;AAFD,4DAEC"}
+{"version":3,"file":"video-cue-points.js","sourceRoot":"","sources":["../../src/video/video-cue-points.ts"],"names":[],"mappings":";;;AACA,8CAAyC;AAoBzC;;;;;GAKG;AACI,MAAM,qBAAqB,GAGN,CAAC,EAAE,EAAE,gBAAgB,EAAE,EAAE;IACnD,IAAI,qBAAQ,KAAK,SAAS,EAAE;QAC1B,MAAM,IAAI,KAAK,CACb,sGAAsG,CACvG,CAAC;KACH;IAED,OAAO,qBAAQ,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,EAAE,EAAE,gBAAgB,CAAC,CAAC;AACzE,CAAC,CAAC;AAXW,QAAA,qBAAqB,yBAWhC"}

package/dist/video/video-extensions.d.ts

@@ -1,4 +1,7 @@
 import { PiletApi } from '@axinom/mosaic-portal';
 import { VideoExtensions } from './types';
+/**
+ * Returns an object containing Extension components for the shared extensions provided by the video service.
+ */
 export declare const bindVideoExtensions: (app: PiletApi) => VideoExtensions;
 //# sourceMappingURL=video-extensions.d.ts.map

package/dist/video/video-extensions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"video-extensions.d.ts","sourceRoot":"","sources":["../../src/video/video-extensions.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAGjD,OAAO,EACL,eAAe,EAGhB,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,mBAAmB,QAAS,QAAQ,KAAG,eAqBnD,CAAC"}
+{"version":3,"file":"video-extensions.d.ts","sourceRoot":"","sources":["../../src/video/video-extensions.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAGjD,OAAO,EACL,eAAe,EAGhB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,eAAO,MAAM,mBAAmB,QAAS,QAAQ,KAAG,eAqBnD,CAAC"}

package/dist/video/video-extensions.js

@@ -6,6 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.bindVideoExtensions = void 0;
 const react_1 = __importDefault(require("react"));
 const common_1 = require("../common");
+/**
+ * Returns an object containing Extension components for the shared extensions provided by the video service.
+ */
 const bindVideoExtensions = (app) => {
     const VideoSelectExplorer = (props) => (react_1.default.createElement(app.Extension, { name: "video-select-explorer", empty: common_1.extensionDefaultValue, params: props }));
     const VideoSelectField = (props) => (react_1.default.createElement(app.Extension, { name: "video-select-field", empty: common_1.extensionDefaultValue, params: props }));

package/dist/video/video-extensions.js.map

@@ -1 +1 @@
-{"version":3,"file":"video-extensions.js","sourceRoot":"","sources":["../../src/video/video-extensions.tsx"],"names":[],"mappings":";;;;;;AACA,kDAA0B;AAC1B,sCAAkD;AAO3C,MAAM,mBAAmB,GAAG,CAAC,GAAa,EAAmB,EAAE;IACpE,MAAM,mBAAmB,GAAuC,CAAC,KAAK,EAAE,EAAE,CAAC,CACzE,8BAAC,GAAG,CAAC,SAAS,IACZ,IAAI,EAAC,uBAAuB,EAC5B,KAAK,EAAE,8BAAqB,EAC5B,MAAM,EAAE,KAAK,GACb,CACH,CAAC;IAEF,MAAM,gBAAgB,GAAoC,CAAC,KAAK,EAAE,EAAE,CAAC,CACnE,8BAAC,GAAG,CAAC,SAAS,IACZ,IAAI,EAAC,oBAAoB,EACzB,KAAK,EAAE,8BAAqB,EAC5B,MAAM,EAAE,KAAK,GACb,CACH,CAAC;IAEF,OAAO;QACL,mBAAmB;QACnB,gBAAgB;KACjB,CAAC;AACJ,CAAC,CAAC;AArBW,QAAA,mBAAmB,uBAqB9B"}
+{"version":3,"file":"video-extensions.js","sourceRoot":"","sources":["../../src/video/video-extensions.tsx"],"names":[],"mappings":";;;;;;AACA,kDAA0B;AAC1B,sCAAkD;AAOlD;;GAEG;AACI,MAAM,mBAAmB,GAAG,CAAC,GAAa,EAAmB,EAAE;IACpE,MAAM,mBAAmB,GAAuC,CAAC,KAAK,EAAE,EAAE,CAAC,CACzE,8BAAC,GAAG,CAAC,SAAS,IACZ,IAAI,EAAC,uBAAuB,EAC5B,KAAK,EAAE,8BAAqB,EAC5B,MAAM,EAAE,KAAK,GACb,CACH,CAAC;IAEF,MAAM,gBAAgB,GAAoC,CAAC,KAAK,EAAE,EAAE,CAAC,CACnE,8BAAC,GAAG,CAAC,SAAS,IACZ,IAAI,EAAC,oBAAoB,EACzB,KAAK,EAAE,8BAAqB,EAC5B,MAAM,EAAE,KAAK,GACb,CACH,CAAC;IAEF,OAAO;QACL,mBAAmB;QACnB,gBAAgB;KACjB,CAAC;AACJ,CAAC,CAAC;AArBW,QAAA,mBAAmB,uBAqB9B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axinom/mosaic-managed-workflow-integration",
-  "version": "0.17.0-rc.0",
+  "version": "0.17.0-rc.2",
   "description": "Shared types and helpers for integrating functionality provided by managed service workflows",
   "author": "Axinom",
   "license": "PROPRIETARY",
@@ -23,8 +23,8 @@
     "lint": "eslint . --ext .ts,.tsx,.js --color --cache"
   },
   "devDependencies": {
-    "@axinom/mosaic-portal": "^0.33.0-rc.0",
-    "@axinom/mosaic-ui": "^0.49.0-rc.0",
+    "@axinom/mosaic-portal": "^0.33.0-rc.2",
+    "@axinom/mosaic-ui": "^0.49.0-rc.2",
     "@types/react": "^17",
     "@types/react-dom": "^17",
     "eslint": "^8.35.0",
@@ -42,5 +42,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2a5aa96ed691c2d3440a40e97ecfb801b868c469"
+  "gitHead": "28fbd2c0bd577a35b943c5a654467cd356b916e9"
 }

package/src/hosting/get-object-storages.tsx

@@ -1,4 +1,4 @@
-import { PiletApi } from '@axinom/mosaic-portal';
+import { piletApi } from '../initialize';
 
 /**
  * Represents an object storage.
@@ -12,15 +12,13 @@ export interface ObjectStorage {
  * Get enabled Object Storages
  * @returns
  */
-export let getObjectStorages = async (): Promise<
+export const getObjectStorages = async (): Promise<
   ObjectStorage[] | undefined
 > => {
-  // eslint-disable-next-line no-console
-  console.error('getObjectStorages is not implemented');
-  return Promise.resolve(undefined);
-};
-
-export const setGetObjectStorages = (app: PiletApi): void => {
-  getObjectStorages = () =>
-    app.getData('getObjectStorages')() ?? getObjectStorages;
+  if (piletApi === undefined) {
+    throw new Error(
+      'The pilet API is not initialized. Please call `initializeIntegrationLib` before using this function.',
+    );
+  }
+  return piletApi.getData('getObjectStorages')();
 };

package/src/image/image-extensions.tsx

@@ -9,6 +9,9 @@ import {
   ImageSelectFieldProps,
 } from './types';
 
+/**
+ * Returns an object containing Extension components for the shared extensions provided by the image service.
+ */
 export const bindImageExtensions = (app: PiletApi): ImageExtensions => {
   const ImageCover: React.FC<ImageCoverProps> = (props) => (
     <app.Extension

package/src/image/thumbnail-renderer.tsx

@@ -1,6 +1,6 @@
-import { PiletApi } from '@axinom/mosaic-portal';
 import { ColumnMap, ColumnRenderer, Data } from '@axinom/mosaic-ui';
 import React from 'react';
+import { piletApi } from '../initialize';
 import {
   ThumbnailProperty,
   ThumbnailResolver,
@@ -8,41 +8,56 @@ import {
 } from './types';
 
 /**
- * A fallback for the `getThumbnailAndStateRenderer` function.
+ * This function simplifies access to the shared functionality provided by the image workflow in the PiletApi object.
+ * In case the shared functionality is not available, a fallback renderer is returned.
+ *
+ * Make sure to initialize the integration library by calling the `initializeIntegrationLib` function,
+ * otherwise it will always return the fallback renderer.
+ *
+ * The renderer expects that the column is bound to the property containing the state. The thumbnail property is passed as an argument.
+ *
+ * @param thumbnailPropertyOrResolver
+ * Either the name of a property on the `data` object that has the following shape:
+ * ```ts
+ * {
+ *  nodes: [{
+ *    imageId: 'b437056b-c28e-46fa-ad9d-8bd16e7609fa'
+ *  }]
+ * }
+ * ```
+ * This reflects the shape a typical postgraphile response would have.
+ * The renderer will pick the fist imageId from the nodes array.
+ *
+ * Alternatively a callback function can be passed that resolves to a url location.
+ * The row data is passed as an argument.
+ * The method can either return the full url of the image or the uuid of the image.
+ * If the uuid is returned, the `resolverType` argument needs to be set to 'uuid'.
+ * @param stateMap An object of key/value pairs mapping column values to CSS colors. If an empty object is passed, no state will be rendered.
+ * ```ts
+ * {
+ *   'PUBLISHED': '#95C842',
+ *   'CHANGED': '#FFC81A',
+ *   'NOT_PUBLISHED': '#DDDDDD',
+ * }
+ * ```
+ * @param resolverType either 'url' or 'uuid', depending on what your resolver is returning.
+ * @returns A thumbnail and state column renderer
  */
-const thumbnailFallback = <T extends Data>(
-  _thumbnailPropertyOrResolver: ThumbnailProperty<T> | ThumbnailResolver<T>,
-  _map?: ColumnMap,
-  _resolverType?: ThumbnailResolverType,
+export const createThumbnailAndStateRenderer = <T extends Data>(
+  thumbnailPropertyOrResolver: ThumbnailProperty<T> | ThumbnailResolver<T>,
+  stateMap?: ColumnMap,
+  resolverType?: ThumbnailResolverType,
 ): ColumnRenderer<T> => {
-  const ThumbnailFallbackRenderer = (
-    _state: unknown,
-    _data: unknown,
-  ): JSX.Element => {
-    return <span title="No Renderer">No Renderer</span>;
+  const Renderer: ColumnRenderer<T> = (value, data) => {
+    if (piletApi?.getData('thumbnailAndStateRenderer')) {
+      return piletApi?.getData('thumbnailAndStateRenderer')(
+        thumbnailPropertyOrResolver,
+        stateMap,
+        resolverType,
+      )(value, data);
+    } else {
+      return <span title="No Renderer">No Renderer</span>;
+    }
   };
-  return ThumbnailFallbackRenderer;
+  return Renderer;
 };
-
-/**
- * A function that returns thumbnail and state renderer function.
- * @returns A thumbnail and state column renderer
- */
-export let getThumbnailAndStateRenderer = <T extends Data>(): ((
-  _thumbnailPropertyOrResolver: ThumbnailProperty<T> | ThumbnailResolver<T>,
-  _map?: ColumnMap,
-  _resolverType?: ThumbnailResolverType,
-) => ColumnRenderer<T>) => thumbnailFallback;
-
-/**
- * Sets the `getThumbnailAndStateRenderer` utility function from the PiletApi object.
- *
- * The `getThumbnailAndStateRenderer` function simplifies access to shared functionality provided by the image workflow in the PiletApi object.
- * It is used to retrieve the thumbnail renderer function, which is supplied by the image pilet.
- *
- * @param app The PiletApi object.
- */
-export function setGetThumbnailAndStateRenderer(app: PiletApi): void {
-  getThumbnailAndStateRenderer = () =>
-    app.getData('thumbnailAndStateRenderer') ?? thumbnailFallback;
-}

package/src/index.ts

@@ -2,6 +2,7 @@ export * from './channel';
 export * from './common';
 export * from './hosting';
 export * from './image';
+export { initializeIntegrationLib } from './initialize';
 export * from './localization';
 export * from './piral-extensions';
 export * from './video';

package/src/initialize.ts

@@ -0,0 +1,11 @@
+import { PiletApi } from '@axinom/mosaic-portal';
+
+export let piletApi: PiletApi | undefined = undefined;
+
+/**
+ * Initializes the integration library with the provided Pilet API.
+ * @param app the PiletAPI object
+ */
+export const initializeIntegrationLib = (app: PiletApi): void => {
+  piletApi = app;
+};

package/src/localization/helpers/localization-generator.ts

@@ -1,4 +1,4 @@
-import { PiletApi } from '@axinom/mosaic-portal';
+import { piletApi } from '../../initialize';
 import { LocalizationGenerator, LocalizationGeneratorParams } from '../types';
 
 /**
@@ -29,9 +29,13 @@ export const getLocalizationEntryPoint = (
 ): string | undefined => localizationEntryPoints[entityType];
 
 /**
- * Use as a callback for method `app.getDataHelper('localization-registration', callback)`
- * to register localization entry points
- * These entry points then can be used to add links in workflows to localization station for the entity
+ * Instead of using this function directly, it is recommended to use `registerLocalizationEntryPoints` function instead.
+ * `registerLocalizationEntryPoints` is a wrapper around this function that provides a more convenient way to register localization entry points.
+ *
+ * This function is designed to be used as callback of the `app.getDataHelper('localization-registration', callback)` call.
+ *
+ * The function returns a function that can be called with a `LocalizationGenerator` function. When this function is called,
+ * it will register the localization entry points that were provided as `data`.
  * @param data Data containing the information needed to register the localization station paths for the entity using the localization generator
  * @returns A function that will register the localization entry points using provided `data`
  * @example
@@ -68,10 +72,10 @@ export function generateLocalizationEntryPoints(
 }
 
 /**
- * To register localization entry points
- * These entry points then can be used to add links in workflows to localization station for the entity
+ * This function can be used to register embedded localization worklfows for entites.
+ * The localization service will register all required stations to provide an embedded localization workflow for the entity.
+ * To query then entry point for a specific entity, to e.g. create a details page action that links to the sub-workflow, use `getLocalizationEntryPoint` function.
  * @param data Data containing the information needed to register the localization station paths for the entity using the localization generator
- * @param app Pilet API instance
  * @example
  * ```ts
  * registerLocalizationEntryPoints([
@@ -85,12 +89,17 @@ export function generateLocalizationEntryPoints(
  *    entityType: 'playlist'
  *  }
  * ]
+ * ```
  */
 export function registerLocalizationEntryPoints(
   data: LocalizationGeneratorParams[],
-  app: PiletApi,
 ): void {
-  app.getDataHelper(
+  if (piletApi === undefined) {
+    throw new Error(
+      'The pilet API is not initialized. Please call `initializeIntegrationLib` before using this function or pass the API object as 2nd parameter.',
+    );
+  }
+  piletApi.getDataHelper(
     'localization-registration',
     generateLocalizationEntryPoints(data),
   );

package/src/video/video-cue-points.ts

@@ -1,5 +1,5 @@
-import { PiletApi } from '@axinom/mosaic-portal';
 import { ID, Maybe } from '../common';
+import { piletApi } from '../initialize';
 import { EncodingState } from './types';
 
 export interface VideoServiceCuePoints {
@@ -19,15 +19,21 @@ export interface VideoData {
   };
 }
 
-export let getVideoCuePointsData: () => (
+/**
+ * Returns the video cue points data for the given video IDs.
+ * This method depends on the `initializeIntegrationLib` function being called before.
+ * @param id The video IDs for which to fetch the cue points data.
+ * @param cuePointTypeKeys Optional array of cue point type keys that will be used as filter for the returend cue points. If not set, will return all cue points.
+ */
+export const getVideoCuePointsData: (
   id: ID[],
   cuePointTypeKeys?: string[],
-) => Promise<VideoData[]>;
+) => Promise<VideoData[]> = (id, cuePointTypeKeys) => {
+  if (piletApi === undefined) {
+    throw new Error(
+      'The pilet API is not initialized. Please call `initializeIntegrationLib` before using this function.',
+    );
+  }
 
-/**
- * Initializes the video-cue-points-data function.
- * @param app The PiletApi object.
- */
-export function setGetVideoCuePointsData(app: PiletApi): void {
-  getVideoCuePointsData = () => app.getData('video-cue-points-data');
-}
+  return piletApi.getData('video-cue-points-data')(id, cuePointTypeKeys);
+};

package/src/video/video-extensions.tsx

@@ -7,6 +7,9 @@ import {
   VideoSelectFieldProps,
 } from './types';
 
+/**
+ * Returns an object containing Extension components for the shared extensions provided by the video service.
+ */
 export const bindVideoExtensions = (app: PiletApi): VideoExtensions => {
   const VideoSelectExplorer: React.FC<VideoSelectExplorerProps> = (props) => (
     <app.Extension