react-covideo-embed 0.1.9 → 0.1.11

package/README.md

@@ -82,6 +82,13 @@ Explore the capabilities of react-covideo-embed through our [Demo Project](https
   - `CTA`
   - `reactions`
 
+## APIs/Functions
+
+### `logoutCovideo()`
+
+- **Type**: `function`
+- **Description**: Log out from Covideo and clear local storage entries associated with Covideo. To reflect the logout status, the CovideoEmbed component should be re-rendered after this function is called.
+
 ## Author
 
 This package is maintained by Covideo.

package/build/index.d.ts

@@ -1,4 +1,57 @@
-export { CovideoEmbed, Environment, Feature } from './app/CovideoEmbed';
-export type { CovideoEmbedProps, EnvironmentType, FeatureType, ShareData, } from './app/CovideoEmbed';
-import { CovideoEmbed } from './app/CovideoEmbed';
-export default CovideoEmbed;
+/// <reference types="react" />
+import './index.css';
+export declare enum Feature {
+    UPLOAD = "upload",
+    FOLDER = "folder",
+    RECORD_SCREEN = "recordScreen",
+    MERGE = "merge",
+    RECORD_CAM = "recordCam",
+    WHEELS_TV = "wheelsTV",
+    RECORD_BOTH = "recordBoth",
+    TRIM = "trim",
+    INSERT = "insert",
+    LANDING_PAGE = "landingPage",
+    QUICKSHARE = "quickshare",
+    CTA = "CTA",
+    VOICEOVER = "voiceover",
+    REACTIONS = "reactions"
+}
+export type FeatureType = 'insert' | 'recordScreen' | 'recordBoth' | 'recordCam' | 'upload' | 'trim' | 'merge' | 'wheelsTV' | 'voiceover' | 'quickshare' | 'folder' | 'landingPage' | 'CTA' | 'reactions';
+export declare enum Environment {
+    SANDBOX = "sandbox",
+    PRODUCTION = "production"
+}
+export type EnvironmentType = 'sandbox' | 'production';
+export type ShareData = {
+    url: string;
+    thumbnail: string;
+    html: string;
+};
+/**
+ * Logout from Covideo.
+ * If called, removes the auth token and other Covideo data from local storage.
+ */
+export declare function logoutCovideo(): void;
+export type CovideoEmbedProps = {
+    /**
+     * JWT token from Covideo.
+     * If provided, disables the module's login/logout pages.
+     * If not provided, users need to log in through the module's login page.
+     */
+    token?: string;
+    /** Which Covideo environment to target */
+    env?: Environment | EnvironmentType;
+    /** Which Covideo features to hide */
+    hideFeatures?: Feature[] | FeatureType[];
+    /**
+     * Callback triggered when a video is inserted.
+     * @param shareData - Contains the video url, thumbnail url and HTML of the inserted video.
+     */
+    onVideoInsert?: (shareData: ShareData) => void;
+    /**
+     * Callback triggered when there is an error inserting a video.
+     * @param error - The error occurred during video insert.
+     */
+    onVideoInsertError?: (error: unknown) => void;
+};
+export declare const CovideoEmbed: React.FC<CovideoEmbedProps>;