@sisense/sdk-ui-vue 2.24.0 → 2.26.0

package/dist/packages/sdk-ui-vue/src/providers/sisense-context-provider/sisense-context-provider.d.ts

@@ -1,205 +0,0 @@
-import type { SisenseContextProviderProps as SisenseContextProviderPropsPreact } from '@sisense/sdk-ui-preact';
-import type { PropType } from 'vue';
-/**
- * Configurations and authentication for Sisense Context.
- *
- * Use one of the following to authenticate:
- *
- * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.ssoEnabled | `ssoEnabled`}
- * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.token | `token`}
- * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.wat | `wat`}
- */
-export interface SisenseContextProviderProps extends SisenseContextProviderPropsPreact {
-}
-/**
- * Sisense Context Provider Component allowing you to connect to
- * a Sisense instance and provide that context
- * to all Compose SDK components in your application.
- *
- * @example
- * Here's how to use the `SisenseContextProvider` component to wrap your Sisense-enabled application:
- * Add SisenseContextProvider to the main component of your app as below and then wrap
- * other SDK components inside this component.
- * ```vue
- * <template>
- *   <SisenseContextProvider
- *     :url="sisenseUrl"
- *     :defaultDataSource="defaultDataSource"
- *     :ssoEnabled="true"
- *     :token="authToken"
- *     :wat="watToken"
- *     :appConfig="appConfigurations"
- *   >
- *     <!-- Your application components here -->
- *   </SisenseContextProvider>
- * </template>
- *
- * <script>
- * import { ref } from 'vue';
- * import SisenseContextProvider from './SisenseContextProvider.vue';
- *
- * export default {
- *   components: { SisenseContextProvider },
- *   setup() {
- *     const sisenseUrl = ref('https://your-sisense-instance.com');
- *     const defaultDataSource = ref('default_datasource_id');
- *     const authToken = ref('your_auth_token');
- *     const watToken = ref('your_wat_token');
- *     const appConfigurations = ref({});
- *
- *     return { sisenseUrl, defaultDataSource, authToken, watToken, appConfigurations };
- *   }
- * };
- * </script>
- * ```
- *
- * @param props - Sisense context provider props
- * @returns A Sisense Context Provider Component
- * @group Contexts
- */
-export declare const SisenseContextProvider: import("vue").DefineComponent<{
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.defaultDataSource}
-     *
-     * @category Sisense App
-     */
-    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.url}
-     *
-     * @category Sisense App
-     */
-    url: {
-        type: PropType<string>;
-        required: true;
-    };
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
-     *
-     * @category Sisense Authentication
-     */
-    ssoEnabled: PropType<boolean | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.token}
-     *
-     * @category Sisense Authentication
-     */
-    token: PropType<string | null | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.wat}
-     *
-     * @category Sisense Authentication
-     */
-    wat: PropType<string | null | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.appConfig}
-     *
-     * @category Sisense App
-     */
-    appConfig: PropType<import("@sisense/sdk-ui-preact").AppConfig | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.plugins}
-     *
-     * @category Sisense App
-     * @internal
-     */
-    plugins: {
-        type: PropType<import("@sisense/sdk-ui-preact").Plugin[] | undefined>;
-        default: () => never[];
-    };
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoMaxAuthRedirectAttempts}
-     *
-     * @category Sisense Authentication
-     * @alpha
-     */
-    ssoMaxAuthRedirectAttempts: PropType<number | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoRedirectAttemptsTtlMs}
-     *
-     * @category Sisense Authentication
-     * @alpha
-     */
-    ssoRedirectAttemptsTtlMs: PropType<number | undefined>;
-    /**
-     * @internal
-     */
-    showRuntimeErrors: {
-        type: PropType<boolean | undefined>;
-        default: boolean;
-    };
-}, () => import("vue/jsx-runtime").JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.defaultDataSource}
-     *
-     * @category Sisense App
-     */
-    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.url}
-     *
-     * @category Sisense App
-     */
-    url: {
-        type: PropType<string>;
-        required: true;
-    };
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
-     *
-     * @category Sisense Authentication
-     */
-    ssoEnabled: PropType<boolean | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.token}
-     *
-     * @category Sisense Authentication
-     */
-    token: PropType<string | null | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.wat}
-     *
-     * @category Sisense Authentication
-     */
-    wat: PropType<string | null | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.appConfig}
-     *
-     * @category Sisense App
-     */
-    appConfig: PropType<import("@sisense/sdk-ui-preact").AppConfig | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.plugins}
-     *
-     * @category Sisense App
-     * @internal
-     */
-    plugins: {
-        type: PropType<import("@sisense/sdk-ui-preact").Plugin[] | undefined>;
-        default: () => never[];
-    };
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoMaxAuthRedirectAttempts}
-     *
-     * @category Sisense Authentication
-     * @alpha
-     */
-    ssoMaxAuthRedirectAttempts: PropType<number | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoRedirectAttemptsTtlMs}
-     *
-     * @category Sisense Authentication
-     * @alpha
-     */
-    ssoRedirectAttemptsTtlMs: PropType<number | undefined>;
-    /**
-     * @internal
-     */
-    showRuntimeErrors: {
-        type: PropType<boolean | undefined>;
-        default: boolean;
-    };
-}>>, {
-    plugins: import("@sisense/sdk-ui-preact").Plugin[] | undefined;
-    showRuntimeErrors: boolean | undefined;
-}, {}>;