@verdocs/web-sdk 1.0.23 → 1.2.0

package/dist/types/components/elements/{search-quick-functions/search-quick-functions.d.ts → verdocs-quick-functions/verdocs-quick-functions.d.ts}

@@ -1,8 +1,11 @@
 import { EventEmitter } from '../../../stencil-public-runtime';
 /**
  * Display quick-function buttons for creating templates and documents.
+ *
+ * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
+ * embed. This Element will reuse the same session produced by logging in via that Embed.
  */
-export declare class SearchQuickFunctions {
+export declare class VerdocsQuickFunctions {
   /**
    * Event fired when an entry is clicked.
    */

package/dist/types/components/elements/{search-quick-functions/search-quick-functions.stories.d.ts → verdocs-quick-functions/verdocs-quick-functions.stories.d.ts}

@@ -1,7 +1,7 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const Default: ({ options, createTemplate, createDocument }: {
+export declare const QuickFunctions: ({ options, createTemplate, createDocument }: {
   options: any;
   createTemplate: any;
   createDocument: any;

package/dist/types/components/elements/verdocs-search-activity/verdocs-search-activity.d.ts

@@ -0,0 +1,28 @@
+import { ITemplate } from '@verdocs/js-sdk/Templates/Types';
+import { IRecentSearch, ISavedSearch } from '@verdocs/js-sdk/Search/Types';
+import { EventEmitter } from '../../../stencil-public-runtime';
+/**
+ * Display a list of starred items.
+ *
+ * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
+ * embed. This Element will reuse the same session produced by logging in via that Embed.
+ */
+export declare class VerdocsSearchActivity {
+  type: 'recent' | 'saved' | 'starred';
+  options: any;
+  /**
+   * Event fired when an entry is clicked.
+   */
+  entrySelected: EventEmitter<IRecentSearch>;
+  emptyMessage: string;
+  authFailure: boolean;
+  title: string;
+  recent: IRecentSearch[];
+  saved: ISavedSearch[];
+  starred: ITemplate[];
+  componentWillLoad(): void;
+  handleSelectEntry(entry: any): void;
+  computePagesText(pages: any): string;
+  computeRecipientsText(recipients: any): any;
+  render(): any;
+}

package/dist/types/components/elements/{search-starred/search-starred.stories.d.ts → verdocs-search-activity/verdocs-search-activity.stories.d.ts}

@@ -4,7 +4,7 @@ declare const _default: Meta<import("@storybook/web-components").Args>;
  * Display a list of starred items (favorite templates).
  */
 export default _default;
-export declare const Default: ({ options, entrySelected }: {
-  options: any;
+export declare const SearchActivity: ({ type, entrySelected }: {
+  type: any;
   entrySelected: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/elements/{search-box/search-box.d.ts → verdocs-search-box/verdocs-search-box.d.ts}

@@ -6,8 +6,11 @@ export interface ISearchEvent {
 }
 /**
  * Displays a customizable input box for search queries.
+ *
+ * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
+ * embed. This Element will reuse the same session produced by logging in via that Embed.
  */
-export declare class SearchBox {
+export declare class VerdocsSearchBox {
   /**
    * The placeholder to display in the input field.
    */

package/dist/types/components/elements/{search-box/search-box.stories.d.ts → verdocs-search-box/verdocs-search-box.stories.d.ts}

@@ -1,7 +1,7 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const Default: ({ type, searchClicked, typeChanged, queryChanged }: {
+export declare const SearchBox: ({ type, searchClicked, typeChanged, queryChanged }: {
   type: any;
   searchClicked: any;
   typeChanged: any;

package/dist/types/components/elements/{search-tabs/search-tabs.d.ts → verdocs-search-tabs/verdocs-search-tabs.d.ts}

@@ -1,5 +1,5 @@
 export declare type TContentType = 'all' | 'document' | 'template' | 'organization';
-export declare class SearchTabs {
+export declare class VerdocsSearchTabs {
   selected: TContentType;
   render(): any;
 }

package/dist/types/components/elements/{search-tabs/search-tabs.stories.d.ts → verdocs-search-tabs/verdocs-search-tabs.stories.d.ts}

@@ -4,6 +4,6 @@ declare const _default: Meta<import("@storybook/web-components").Args>;
  * Display a set of tabs to filter by searchable content types.
  */
 export default _default;
-export declare const Default: ({ options }: {
+export declare const Tabs: ({ options }: {
   options: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/embeds/verdocs-auth/verdocs-auth.d.ts

@@ -0,0 +1,69 @@
+import { IActiveSession } from '@verdocs/js-sdk/Users/Types';
+import { EventEmitter } from '../../../stencil-public-runtime';
+export interface IAuthStatus {
+  authenticated: boolean;
+  session: any | null;
+}
+/**
+ * Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that
+ * occur during the process (especially successful completion). The success callback will be fired immediately if the
+ * user is already authenticated with a valid session, so this component may not always display visibly. To simplify
+ * some types of authentication flows, a visibility flag can force this component to never display.
+ *
+ * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
+ * container to allow sufficient space for the required forms.
+ *
+ * As noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after
+ * the widget is rendered and the user's status has been checked. It may be fired again as the user completes (or
+ * cancels) authentication steps.
+ *
+ * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
+ * embed. This Element will reuse the same session produced by logging in via that Embed.
+ *
+ * ```typescript
+ * interface IAuthStatus {
+ *   // If true, the user is authenticated with a valid session
+ *   authenticated: boolean;
+ *
+ *   // Details for the user's session
+ *   session: IActiveSession | null;
+ * }
+ * ```
+ */
+export declare class VerdocsAuth {
+  /**
+   * Normally, if the user has a valid session, this embed will be invisible, otherwise it will display
+   * login / signup forms. If this is set to false, this embed will be invisible in both cases. Apps may
+   * use this to verify if a user has a valid session without needing a separate call to Verdocs JS SDK.
+   */
+  visible: boolean;
+  /**
+   * By default, a Verdocs logo will be displayed above the login/signup forms. This may be used to
+   * override its source. (Alternatively, you may simply hide it via CSS overrides.) Logos should be
+   * in SVG format for best results.
+   */
+  logo: string;
+  /**
+   * If the user is authenticated, this embed will normally render invisibly. If debug is set true, a summary
+   * if the user's session details will be displayed instead. This may be useful while debugging authentication
+   * flows in new applications.
+   */
+  debug: boolean;
+  /**
+   * Event fired when session authentication process has completed. Check the event contents for completion status.
+   */
+  authenticated: EventEmitter<IAuthStatus>;
+  isAuthenticated: boolean;
+  displayMode: string;
+  username: string;
+  password: string;
+  loggingIn: boolean;
+  activeSession: IActiveSession | null;
+  loginError: string | null;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  handleLogin(): void;
+  handleLogout(): void;
+  handleClearError(): void;
+  render(): any;
+}

package/dist/types/components/embeds/verdocs-auth/verdocs-auth.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta } from '@storybook/web-components';
+declare const _default: Meta<import("@storybook/web-components").Args>;
+export default _default;
+export declare const Auth: ({ visible, logo, debug, authenticated }: {
+  visible: any;
+  logo: any;
+  debug: any;
+  authenticated: any;
+}) => import("lit-html").TemplateResult<1>;

package/dist/types/components/embeds/verdocs-search/verdocs-search.d.ts

@@ -0,0 +1,3 @@
+export declare class VerdocsSearch {
+  render(): any;
+}

package/dist/types/components/embeds/{search-embed/search-embed.stories.d.ts → verdocs-search/verdocs-search.stories.d.ts}

@@ -1,6 +1,6 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const Default: ({ options }: {
+export declare const Search: ({ options }: {
   options: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/embeds/verdocs-sign/verdocs-sign.d.ts

@@ -0,0 +1,46 @@
+import { IDocument, IDocumentField } from '@verdocs/js-sdk/Documents/Documents';
+import { IPDFPageInfo, IPDFRenderEvent } from '../verdocs-view/verdocs-view';
+/**
+ * Display a document signing experience.
+ */
+export declare class VerdocsSign {
+  /**
+   * If `source` is set to `verdocs-sign`, this should be set to a valid invitation code to activate a
+   * signing session.
+   */
+  documentid: string | null;
+  /**
+   * If `source` is set to `verdocs-sign`, this should be set to a valid invitation code to activate a
+   * signing session.
+   */
+  roleid: string | null;
+  /**
+   * If `source` is set to `verdocs-sign`, this should be set to a valid invitation code to activate a
+   * signing session.
+   */
+  invitecode: string | null;
+  endpoint: any;
+  recipient: any;
+  signerToken: any;
+  pdfUrl: any;
+  recipientIndex: number;
+  document: IDocument | null;
+  fields: IDocumentField[];
+  pdfPageInfo: IPDFRenderEvent;
+  hasSignature: boolean;
+  nextButtonLabel: string;
+  focusedField: string;
+  componentWillLoad(): void;
+  componentDidLoad(): Promise<void>;
+  handleClickAgree(): void;
+  savePDF(): Promise<void>;
+  handleOptionSelected(e: any): Promise<void>;
+  handleFieldChange(field: IDocumentField, e: any, optionId?: string): Promise<void>;
+  renderCheckboxGroupOption(page: IPDFPageInfo, field: IDocumentField, option: any, index: number): any;
+  renderRadioGroupOption(page: IPDFPageInfo, field: IDocumentField, option: any, index: number): any;
+  renderField(field: IDocumentField, index: number): any;
+  isFieldValid(field: IDocumentField): boolean;
+  handleDocumentRendered(e: any): void;
+  handleNext(): void;
+  render(): any;
+}

package/dist/types/components/embeds/verdocs-sign/verdocs-sign.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta } from '@storybook/web-components';
+declare const _default: Meta<import("@storybook/web-components").Args>;
+export default _default;
+export declare const Sign: ({ documentid, roleid, invitecode, authenticated }: {
+  documentid: any;
+  roleid: any;
+  invitecode: any;
+  authenticated: any;
+}) => import("lit-html").TemplateResult<1>;

package/dist/types/components/embeds/verdocs-view/verdocs-view.d.ts

@@ -0,0 +1,77 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { OnProgressParameters } from 'pdfjs-dist/types/src/display/api';
+export interface IPDFPageInfo {
+  height: number;
+  width: number;
+  originalHeight: number;
+  originalWidth: number;
+  xRatio: number;
+  yRatio: number;
+  pageNumber: number;
+  canvasTop: number;
+  canvasRight: number;
+  canvasLeft: number;
+  canvasBottom: number;
+}
+export interface IPDFRenderEvent {
+  numRendered: number;
+  numPages: number;
+  pages: IPDFPageInfo[];
+  canvasContainer: HTMLDivElement;
+}
+export declare class VerdocsView {
+  component: HTMLElement;
+  private pdfDocument;
+  private pdfContainer;
+  private numPages;
+  private fingerprint;
+  /**
+   * Rotate the PDF in degrees
+   */
+  rotation: 0 | 90 | 180 | 270;
+  /**
+   * Src of the PDF to load and render
+   */
+  source: string;
+  /**
+   * Access token to use. This component is a wrapper for PDF.js which does not use a VerdocsEndpoint, so the token must be supplied
+   * directly.
+   */
+  token: string | null;
+  /**
+   * Listen for changes to src
+   */
+  doSrc(newValue: string | null, oldValue: string | null): void;
+  /**
+   * Fired when a page has been rendered
+   */
+  pageRendered: EventEmitter<IPDFRenderEvent>;
+  /**
+   * Fired when a page has been changed
+   */
+  pageLoaded: EventEmitter<number>;
+  /**
+   * Fired when a page has been changed
+   */
+  pageChange: EventEmitter<number>;
+  /**
+   * Fired when a page has been initialized
+   */
+  pageInit: EventEmitter<number>;
+  /**
+   * Fired when a page has been scaled
+   */
+  scaleChange: EventEmitter<number>;
+  /**
+   * Fired when the document has completed rendered. The event will include the rendered page count.
+   */
+  documentRendered: EventEmitter<IPDFRenderEvent>;
+  loadProgress: number;
+  pagesRendered: IPDFPageInfo[];
+  isRotated(rotation: any): boolean;
+  renderPages(): Promise<void>;
+  componentDidLoad(): void;
+  onProgress(progress: OnProgressParameters): void;
+  loadAndRender(src: string): void;
+  render(): any;
+}

package/dist/types/components/embeds/verdocs-view/verdocs-view.stories.d.ts

@@ -0,0 +1,6 @@
+import { Meta } from '@storybook/web-components';
+declare const _default: Meta<import("@storybook/web-components").Args>;
+export default _default;
+export declare const View: ({ source }: {
+  source: any;
+}) => import("lit-html").TemplateResult<1>;