@axinom/mosaic-messages 0.29.0-rc.0 → 0.29.0-rc.17

package/dist/generated/schemas/payloads/video/types/playback-video-webhook-request-payload.json

@@ -0,0 +1,476 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "playback_video_webhook_request_payload",
+    "description": "The webhook payload schema to request the entitlement message JWT and HLS and/or DASH manifest URL(s) for video playback.",
+    "additionalProperties": true,
+    "required": [
+        "video",
+        "management_user"
+    ],
+    "properties": {
+        "video": {
+            "type": "object",
+            "title": "video",
+            "description": "Video metadata to be used to enable its playback.",
+            "additionalProperties": true,
+            "required": [
+                "id",
+                "title",
+                "source_location",
+                "is_archived",
+                "videos_tags",
+                "video_encoding"
+            ],
+            "properties": {
+                "id": {
+                    "type": "string",
+                    "minLength": 32,
+                    "maxLength": 36,
+                    "format": "uuid",
+                    "description": "A UUID."
+                },
+                "title": {
+                    "type": "string",
+                    "description": "Video title"
+                },
+                "source_file_name": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Source file name"
+                },
+                "source_file_extension": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Source file extension"
+                },
+                "source_full_file_name": {
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "description": "Full source file name, including extension"
+                },
+                "source_location": {
+                    "type": "string",
+                    "description": "Path to the folder in the storage that contains source video files"
+                },
+                "source_size_in_bytes": {
+                    "type": [
+                        "number",
+                        "null"
+                    ],
+                    "description": "Combined size of all source video files"
+                },
+                "is_archived": {
+                    "type": "boolean",
+                    "description": "Is video archived or not"
+                },
+                "videos_tags": {
+                    "type": "array",
+                    "description": "An array of video tag values.",
+                    "uniqueItems": true,
+                    "additionalItems": false,
+                    "items": {
+                        "type": "string",
+                        "description": "A tag value."
+                    }
+                },
+                "video_encoding": {
+                    "type": "object",
+                    "title": "video_encoding",
+                    "description": "Information about specific video encoding.",
+                    "additionalProperties": true,
+                    "required": [
+                        "is_protected",
+                        "encoding_state",
+                        "output_format",
+                        "preview_status",
+                        "video_streams",
+                        "audio_languages",
+                        "subtitle_languages",
+                        "caption_languages"
+                    ],
+                    "properties": {
+                        "is_protected": {
+                            "type": "boolean",
+                            "description": "Is video DRM-protected or not"
+                        },
+                        "title": {
+                            "type": "string",
+                            "description": "Video title"
+                        },
+                        "encoding_state": {
+                            "type": "string",
+                            "title": "encoding_state",
+                            "enum": [
+                                "NOT_STARTED",
+                                "INITIALIZING",
+                                "WAITING",
+                                "IN_PROGRESS",
+                                "READY",
+                                "ERROR"
+                            ],
+                            "description": "Encoding state."
+                        },
+                        "output_format": {
+                            "type": "string",
+                            "title": "output_format",
+                            "enum": [
+                                "HLS",
+                                "DASH",
+                                "DASH_HLS",
+                                "CMAF",
+                                "DASH_ON_DEMAND"
+                            ],
+                            "description": "Output format."
+                        },
+                        "output_location": {
+                            "type": "string",
+                            "description": "Output location"
+                        },
+                        "dash_size_in_bytes": {
+                            "type": [
+                                "number",
+                                "null"
+                            ],
+                            "description": "DASH output size in bytes"
+                        },
+                        "hls_size_in_bytes": {
+                            "type": [
+                                "number",
+                                "null"
+                            ],
+                            "description": "HLS output size in bytes"
+                        },
+                        "cmaf_size_in_bytes": {
+                            "type": [
+                                "number",
+                                "null"
+                            ],
+                            "description": "CMAF output size in bytes"
+                        },
+                        "dash_manifest_path": {
+                            "type": [
+                                "string",
+                                "null"
+                            ],
+                            "description": "Path to the DASH manifest in the output storage"
+                        },
+                        "hls_manifest_path": {
+                            "type": [
+                                "string",
+                                "null"
+                            ],
+                            "description": "Path to the HLS manifest in the output storage"
+                        },
+                        "audio_languages": {
+                            "type": "array",
+                            "description": "An array of audio language values.",
+                            "uniqueItems": true,
+                            "additionalItems": false,
+                            "items": {
+                                "type": [
+                                    "string",
+                                    "null"
+                                ],
+                                "description": "An audio language value."
+                            }
+                        },
+                        "caption_languages": {
+                            "type": "array",
+                            "description": "An array of closed caption language values.",
+                            "uniqueItems": true,
+                            "additionalItems": false,
+                            "items": {
+                                "type": [
+                                    "string",
+                                    "null"
+                                ],
+                                "description": "A closed caption language value."
+                            }
+                        },
+                        "subtitle_languages": {
+                            "type": "array",
+                            "description": "An array of subtitle language values.",
+                            "uniqueItems": true,
+                            "additionalItems": false,
+                            "items": {
+                                "type": [
+                                    "string",
+                                    "null"
+                                ],
+                                "description": "A subtitle language value."
+                            }
+                        },
+                        "duration_in_seconds": {
+                            "type": [
+                                "number",
+                                "null"
+                            ],
+                            "description": "@deprecated Use `length_in_seconds` instead"
+                        },
+                        "length_in_seconds": {
+                            "type": [
+                                "number",
+                                "null"
+                            ],
+                            "description": "Video length in seconds"
+                        },
+                        "finished_date": {
+                            "type": [
+                                "string",
+                                "null"
+                            ],
+                            "description": "ISO 8601 Datetime when the encoding finished"
+                        },
+                        "preview_status": {
+                            "type": "string",
+                            "title": "preview_status",
+                            "enum": [
+                                "NOT_PREVIEWED",
+                                "NOT_APPROVED",
+                                "APPROVED"
+                            ],
+                            "description": "Preview status."
+                        },
+                        "preview_comment": {
+                            "type": [
+                                "string",
+                                "null"
+                            ],
+                            "description": "Preview comment"
+                        },
+                        "video_streams": {
+                            "type": "array",
+                            "description": "An array of video stream objects.",
+                            "additionalItems": false,
+                            "items": {
+                                "type": "object",
+                                "title": "video_stream",
+                                "description": "Information about the video streams for the video encoding.",
+                                "additionalProperties": true,
+                                "required": [
+                                    "label",
+                                    "format"
+                                ],
+                                "properties": {
+                                    "label": {
+                                        "type": "string",
+                                        "description": "Stream label for grouping streams by the same quality level: audio, sd, hd, uhd1, uhd2."
+                                    },
+                                    "format": {
+                                        "type": "string",
+                                        "title": "output_format",
+                                        "enum": [
+                                            "HLS",
+                                            "DASH",
+                                            "DASH_HLS",
+                                            "CMAF",
+                                            "DASH_ON_DEMAND"
+                                        ],
+                                        "description": "Output format."
+                                    },
+                                    "type": {
+                                        "type": "string",
+                                        "title": "video_stream_type",
+                                        "enum": [
+                                            "VIDEO",
+                                            "AUDIO",
+                                            "SUBTITLE",
+                                            "CLOSED_CAPTION"
+                                        ],
+                                        "description": "Stream type"
+                                    },
+                                    "file": {
+                                        "type": [
+                                            "string",
+                                            "null"
+                                        ],
+                                        "description": "File path to the initialization segment"
+                                    },
+                                    "key_id": {
+                                        "type": [
+                                            "string",
+                                            "null"
+                                        ],
+                                        "description": "Key ID"
+                                    },
+                                    "iv": {
+                                        "type": [
+                                            "string",
+                                            "null"
+                                        ],
+                                        "description": "IV"
+                                    },
+                                    "bitrate_in_kbps": {
+                                        "type": [
+                                            "number",
+                                            "null"
+                                        ],
+                                        "description": "Bitrate in kilobits per second"
+                                    },
+                                    "file_template": {
+                                        "type": [
+                                            "string",
+                                            "null"
+                                        ],
+                                        "description": "File Template"
+                                    },
+                                    "codecs": {
+                                        "type": [
+                                            "string",
+                                            "null"
+                                        ],
+                                        "description": "The used codec like H.264 (AVC), H.265 (HEVC), AAC, ..."
+                                    },
+                                    "frame_rate": {
+                                        "type": [
+                                            "number",
+                                            "null"
+                                        ],
+                                        "description": "Frames per second of the video stream"
+                                    },
+                                    "height": {
+                                        "type": [
+                                            "integer",
+                                            "null"
+                                        ],
+                                        "description": "Height in pixels of the video stream"
+                                    },
+                                    "width": {
+                                        "type": [
+                                            "integer",
+                                            "null"
+                                        ],
+                                        "description": "Width in pixels of the video stream"
+                                    },
+                                    "display_aspect_ratio": {
+                                        "type": [
+                                            "string",
+                                            "null"
+                                        ],
+                                        "description": "The proportional relationship between the width and the height of how to display the video like 16:9, 4:3, 3:2, ..."
+                                    },
+                                    "pixel_aspect_ratio": {
+                                        "type": [
+                                            "string",
+                                            "null"
+                                        ],
+                                        "description": "This ratio describes how the width of a pixel compares to the height of that pixel e.g. 1:1. But pixels are not always square."
+                                    },
+                                    "sampling_rate": {
+                                        "type": [
+                                            "integer",
+                                            "null"
+                                        ],
+                                        "description": "The average number of samples in one second for audio streams."
+                                    },
+                                    "language_code": {
+                                        "type": [
+                                            "string",
+                                            "null"
+                                        ],
+                                        "description": "Language code for for audio, subtitle, or caption streams"
+                                    },
+                                    "language_name": {
+                                        "type": [
+                                            "string",
+                                            "null"
+                                        ],
+                                        "description": "Language name for audio, subtitle, or caption streams"
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "management_user": {
+            "type": "object",
+            "title": "management_user",
+            "description": "Management user metadata to be used to enable video playback.",
+            "additionalProperties": true,
+            "required": [
+                "tenant_id",
+                "environment_id",
+                "name",
+                "permissions",
+                "subject_type",
+                "iat",
+                "aud",
+                "iss",
+                "sub"
+            ],
+            "properties": {
+                "tenant_id": {
+                    "type": "string",
+                    "description": "Tenant ID"
+                },
+                "environment_id": {
+                    "type": "string",
+                    "description": "Environment ID"
+                },
+                "name": {
+                    "type": "string",
+                    "description": "User name"
+                },
+                "email": {
+                    "type": "string",
+                    "description": "User email"
+                },
+                "permissions": {
+                    "type": "object",
+                    "title": "permissions",
+                    "description": "Permissions assigned to the user",
+                    "additionalProperties": {
+                        "type": "array",
+                        "description": "An array of permissions for the service.",
+                        "uniqueItems": true,
+                        "additionalItems": false,
+                        "items": {
+                            "type": "string",
+                            "description": "A permission name."
+                        }
+                    }
+                },
+                "subject_type": {
+                    "type": "string",
+                    "title": "subject_type",
+                    "description": "Type of the subject/user",
+                    "enum": [
+                        "ManagedServiceAccount",
+                        "ServiceAccount",
+                        "UserAccount",
+                        "ImpersonatedUserAccount",
+                        "SuperUserAccount",
+                        "EnvironmentAdminAccount",
+                        "EndUserAccount",
+                        "EndUserApplication"
+                    ]
+                },
+                "iat": {
+                    "type": "number",
+                    "description": "Issued at (seconds since Unix epoch)"
+                },
+                "aud": {
+                    "type": "string",
+                    "description": "Audience of the original token"
+                },
+                "iss": {
+                    "type": "string",
+                    "description": "Issuer of the original token"
+                },
+                "sub": {
+                    "type": "string",
+                    "description": "Subject/user identifier"
+                }
+            }
+        }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axinom/mosaic-messages",
-  "version": "0.29.0-rc.0",
+  "version": "0.29.0-rc.17",
   "description": "Shared types for Axinom Mosaic service messages",
   "author": "Axinom",
   "license": "PROPRIETARY",
@@ -29,8 +29,8 @@
     "dev": "concurrently --names \"codegen,tsc\" \"yarn codegen:watch\" \"yarn build:compile:watch\""
   },
   "devDependencies": {
-    "@axinom/mosaic-cli": "^0.18.5-rc.2",
-    "@axinom/mosaic-message-bus-abstractions": "^0.5.6-rc.2",
+    "@axinom/mosaic-cli": "^0.19.0-rc.16",
+    "@axinom/mosaic-message-bus-abstractions": "^0.5.6-rc.19",
     "@types/glob": "^7.1.3",
     "concurrently": "^5.3.0",
     "rimraf": "^3.0.2",
@@ -42,5 +42,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d097678632aee4af6bbe24d3db3ff3c43f46311d"
+  "gitHead": "0f3039c90160e439e04093e4e66d711523530e08"
 }

package/src/generated/schemas/payloads/ax-auth/index.ts

@@ -1,2 +1,3 @@
 export * from './commands';
-export * from './events';
+export * from './events';
+export * from './types';

package/src/generated/schemas/payloads/ax-auth/types/index.ts

@@ -0,0 +1,5 @@
+import * as PasswordResetWebhookPayload from './password-reset-webhook-payload.json';
+import * as UserSignUpWebhookPayload from './user-sign-up-webhook-payload.json';
+
+export const PasswordResetWebhookPayloadSchema = PasswordResetWebhookPayload;
+export const UserSignUpWebhookPayloadSchema = UserSignUpWebhookPayload;

package/src/generated/schemas/payloads/ax-auth/types/password-reset-webhook-payload.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "password_reset_webhook_payload",
+  "description": "The webhook payload schema for password reset.",
+  "additionalProperties": false,
+  "required": [
+    "email",
+    "reset_otp"
+  ],
+  "properties": {
+    "email": {
+      "type": "string",
+      "description": "Email of the user resetting the password."
+    },
+    "reset_otp": {
+      "type": "string",
+      "description": "OTP that must be used to confirm the password reset."
+    },
+    "first_name": {
+      "type": "string",
+      "description": "First name."
+    },
+    "last_name": {
+      "type": "string",
+      "description": "Last name."
+    },
+    "custom_data": {
+      "type": "object",
+      "title": "custom_data",
+      "description": "Any custom data that will be passed on to the webhook, coming with the Sign Up request."
+    }
+  }
+}

package/src/generated/schemas/payloads/ax-auth/types/user-sign-up-webhook-payload.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "user_sign_up_webhook_payload",
+  "description": "The webhook payload schema for end user sign up.",
+  "additionalProperties": false,
+  "required": [
+    "email",
+    "sign_up_otp"
+  ],
+  "properties": {
+    "email": {
+      "type": "string",
+      "description": "Email of the user signing up."
+    },
+    "sign_up_otp": {
+      "type": "string",
+      "description": "OTP that must be used to confirm the user sign up."
+    },
+    "first_name": {
+      "type": "string",
+      "description": "First name."
+    },
+    "last_name": {
+      "type": "string",
+      "description": "Last name."
+    },
+    "custom_data": {
+      "type": "object",
+      "title": "custom_data",
+      "description": "Any custom data that will be passed on to the webhook, coming with the Sign Up request."
+    }
+  }
+}

package/src/generated/schemas/payloads/user/index.ts

@@ -1,2 +1,3 @@
 export * from './commands';
-export * from './events';
+export * from './events';
+export * from './types';

package/src/generated/schemas/payloads/user/types/access-token-enrichment-webhook-request-payload.json

@@ -0,0 +1,62 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "access_token_enrichment_webhook_request_payload",
+  "description": "The request payload schema for Access Token Enrichment webhook.",
+  "additionalProperties": false,
+  "required": [
+    "tenant_id",
+    "environment_id",
+    "application_id",
+    "session_id",
+    "subject_type",
+    "profile_id",
+    "name",
+    "email"
+  ],
+  "properties": {
+    "tenant_id": {
+      "type": "string",
+      "description": "Tenant ID"
+    },
+    "environment_id": {
+      "type": "string",
+      "description": "Environment ID"
+    },
+    "application_id": {
+      "type": "string",
+      "description": "Application ID"
+    },
+    "session_id": {
+      "type": "string",
+      "description": "Session ID"
+    },
+    "subject_type": {
+      "title": "TokenSubjectType",
+      "type": "string",
+      "enum": [
+        "EndUserAccount",
+        "EndUserApplication"
+      ],
+      "description": "Subject Type"
+    },
+    "profile_id": {
+      "type": "string",
+      "description": "Profile ID"
+    },
+    "name": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "Name"
+    },
+    "email": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "Email"
+    }
+  }
+}

package/src/generated/schemas/payloads/user/types/access-token-enrichment-webhook-response-payload.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "access_token_enrichment_webhook_response_payload",
+  "description": "The response payload schema for Access Token Enrichment webhook.",
+  "additionalProperties": true,
+  "properties": {}
+}