@teambit/component 1.0.228 → 1.0.229

package/dist/component.main.runtime.d.ts

@@ -0,0 +1,75 @@
+import { CLIMain } from '@teambit/cli';
+import { ExpressMain, Route } from '@teambit/express';
+import { GraphqlMain } from '@teambit/graphql';
+import { SlotRegistry } from '@teambit/harmony';
+import { ComponentID } from '@teambit/component-id';
+import { ExtensionDataList } from '@teambit/legacy/dist/consumer/config';
+import { ComponentFactory } from './component-factory';
+import { AspectList } from './aspect-list';
+import { AspectEntry } from './aspect-entry';
+import { ShowFragment } from './show';
+import { RegisteredComponentRoute } from '.';
+export type ComponentHostSlot = SlotRegistry<ComponentFactory>;
+export type ShowFragmentSlot = SlotRegistry<ShowFragment[]>;
+export declare class ComponentMain {
+    /**
+     * slot for component hosts to register.
+     */
+    private hostSlot;
+    /**
+     * Express Extension
+     */
+    private express;
+    private showFragmentSlot;
+    constructor(
+    /**
+     * slot for component hosts to register.
+     */
+    hostSlot: ComponentHostSlot, 
+    /**
+     * Express Extension
+     */
+    express: ExpressMain, showFragmentSlot: ShowFragmentSlot);
+    /**
+     * register a new component host.
+     */
+    registerHost(host: ComponentFactory): this;
+    /**
+     * important! avoid using this method.
+     * seems like this method was written to work around a very specific case when the ComponentID of the aspects are
+     * not available. in case of new components, to get the ComponentID, the workspace-aspect is needed to get the
+     * default-scope. when this method is called from the scope, there is no way to get the real component-id.
+     * instead, this method asks for the "scope", which when called by the scope-aspect is the current scope-name.
+     * it may or may not be the real scope-name of the aspect.
+     * to fix this possibly incorrect scope-name, the `workspace.resolveScopeAspectListIds()` checks whether the
+     * scope-name is the same as scope.name, and if so, resolve it to the correct scope-name.
+     */
+    createAspectListFromLegacy(legacyExtensionDataList: ExtensionDataList): AspectList;
+    createAspectListFromEntries(entries: AspectEntry[]): AspectList;
+    registerRoute(routes: RegisteredComponentRoute[]): this;
+    /**
+     * set the prior host.
+     */
+    setHostPriority(id: string): this;
+    /**
+     * get component host by extension ID.
+     */
+    getHost(id?: string): ComponentFactory;
+    getHostIfExist(id?: string): ComponentFactory | undefined;
+    getRoute(id: ComponentID, routeName: string): string;
+    /**
+     * get the prior host.
+     */
+    private getPriorHost;
+    getShowFragments(): ShowFragment[];
+    isHost(name: string): boolean;
+    /**
+     * register a show fragment to display further information in the `bit show` command.
+     */
+    registerShowFragments(showFragments: ShowFragment[]): this;
+    private _priorHost;
+    static slots: (((registerFn: () => string) => SlotRegistry<Route[]>) | ((registerFn: () => string) => SlotRegistry<ComponentFactory>) | ((registerFn: () => string) => SlotRegistry<ShowFragment[]>))[];
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static provider([graphql, express, cli]: [GraphqlMain, ExpressMain, CLIMain], config: any, [hostSlot, showFragmentSlot]: [ComponentHostSlot, ShowFragmentSlot]): Promise<ComponentMain>;
+}

package/dist/component.route.d.ts

@@ -0,0 +1,18 @@
+import { NextFunction, Request, Response, Route } from '@teambit/express';
+import { ComponentMain } from './component.main.runtime';
+export type RegisteredComponentRoute = Route & {
+    resolveComponent?: boolean;
+};
+export type ComponentUrlParams = {
+    componentId: string;
+};
+export declare class ComponentRoute implements Route {
+    private registerRoute;
+    private componentExtension;
+    constructor(registerRoute: RegisteredComponentRoute, componentExtension: ComponentMain);
+    dynamicRouteRegex: string;
+    readonly route: string;
+    get componentMiddlewares(): ((req: Request<ComponentUrlParams>, res: Response, next: NextFunction) => Promise<void>)[];
+    method: string;
+    middlewares: ((req: Request<ComponentUrlParams>, res: Response, next: NextFunction) => Promise<void>)[];
+}

package/dist/component.ui.runtime.d.ts

@@ -0,0 +1,104 @@
+/// <reference types="lodash" />
+import type { RouteProps } from 'react-router-dom';
+import type { LinkProps } from '@teambit/base-react.navigation.link';
+import { CommandBarUI } from '@teambit/command-bar';
+import { SlotRegistry } from '@teambit/harmony';
+import { PubsubUI } from '@teambit/pubsub';
+import { ReactRouterUI } from '@teambit/react-router';
+import { MenuItem, MenuItemSlot } from '@teambit/ui-foundation.ui.main-dropdown';
+import type { NavigationSlot, RouteSlot } from '@teambit/ui-foundation.ui.react-router.slot-router';
+import { ComponentModel } from './ui';
+import { ComponentPageElement, ComponentPageSlot } from './ui/component';
+import { ComponentResultPlugin } from './ui/component-searcher';
+import { ConsumeMethodSlot, ConsumePlugin, NavPlugin, OrderedNavigationSlot, RightSideMenuItem, RightSideMenuSlot } from './ui/menu';
+import { GetComponentsOptions } from './get-component-opts';
+export type ComponentSearchResultSlot = SlotRegistry<ComponentResultPlugin[]>;
+export type ComponentUIConfig = {
+    commandBar: boolean;
+};
+export type Server = {
+    env: string;
+    url: string;
+};
+export type ComponentMeta = {
+    id: string;
+};
+export declare class ComponentUI {
+    /**
+     * Pubsub aspects
+     */
+    private pubsub;
+    private routeSlot;
+    private navSlot;
+    readonly consumeMethodSlot: ConsumeMethodSlot;
+    /**
+     * slot for registering a new widget to the menu.
+     */
+    private widgetSlot;
+    /**
+     * slot for registering the right section of the menu
+     */
+    private rightSideMenuSlot;
+    private menuItemSlot;
+    private pageItemSlot;
+    private componentSearchResultSlot;
+    private commandBarUI;
+    readonly routePath = "/*";
+    private componentSearcher;
+    constructor(
+    /**
+     * Pubsub aspects
+     */
+    pubsub: PubsubUI, routeSlot: RouteSlot, navSlot: OrderedNavigationSlot, consumeMethodSlot: ConsumeMethodSlot, 
+    /**
+     * slot for registering a new widget to the menu.
+     */
+    widgetSlot: OrderedNavigationSlot, 
+    /**
+     * slot for registering the right section of the menu
+     */
+    rightSideMenuSlot: RightSideMenuSlot, menuItemSlot: MenuItemSlot, pageItemSlot: ComponentPageSlot, componentSearchResultSlot: ComponentSearchResultSlot, commandBarUI: CommandBarUI, reactRouterUi: ReactRouterUI);
+    get routes(): [string, RouteProps[]][];
+    /**
+     * the current visible component
+     */
+    private activeComponent?;
+    formatToInstallableVersion(version: string): string;
+    private copyNpmId;
+    /**
+     * key bindings used by component aspect
+     */
+    private keyBindings;
+    private menuItems;
+    private bitMethod;
+    registerPubSub(): void;
+    handleComponentChange: (activeComponent?: ComponentModel) => void;
+    getComponentUI(host: string, options?: GetComponentsOptions): import("react/jsx-runtime").JSX.Element;
+    getMenu(host: string, options?: GetComponentsOptions): import("react/jsx-runtime").JSX.Element;
+    listMenuItems(): import("lodash").Dictionary<MenuItem[]>;
+    registerRoute(routes: RouteProps[] | RouteProps): this;
+    registerNavigation(nav: LinkProps, order?: number): void;
+    registerConsumeMethod(...consumeMethods: ConsumePlugin[]): void;
+    registerWidget(widget: LinkProps, order?: number): void;
+    registerRightSideMenuItem(...rightSideMenuItem: RightSideMenuItem[]): void;
+    registerMenuItem: (menuItems: MenuItem[]) => void;
+    registerPageItem: (...items: ComponentPageElement[]) => void;
+    /** register widgets to the components listed in the command bar */
+    registerSearchResultWidget: (...items: ComponentResultPlugin[]) => void;
+    updateComponents: (components: ComponentModel[]) => void;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static slots: (((registerFn: () => string) => SlotRegistry<RouteProps>) | ((registerFn: () => string) => SlotRegistry<NavigationSlot>) | ((registerFn: () => string) => SlotRegistry<MenuItemSlot>) | ((registerFn: () => string) => SlotRegistry<NavPlugin>) | ((registerFn: () => string) => SlotRegistry<ConsumeMethodSlot>) | ((registerFn: () => string) => SlotRegistry<ComponentPageSlot>) | ((registerFn: () => string) => SlotRegistry<ComponentSearchResultSlot>) | ((registerFn: () => string) => SlotRegistry<RightSideMenuSlot>))[];
+    static defaultConfig: ComponentUIConfig;
+    static provider([pubsub, commandBarUI, reactRouterUI]: [PubsubUI, CommandBarUI, ReactRouterUI], config: ComponentUIConfig, [routeSlot, navSlot, consumeMethodSlot, widgetSlot, menuItemSlot, pageSlot, componentSearchResultSlot, rightSideMenuSlot,]: [
+        RouteSlot,
+        OrderedNavigationSlot,
+        ConsumeMethodSlot,
+        OrderedNavigationSlot,
+        MenuItemSlot,
+        ComponentPageSlot,
+        ComponentSearchResultSlot,
+        RightSideMenuSlot
+    ]): Promise<ComponentUI>;
+}
+export default ComponentUI;

package/dist/config.d.ts

@@ -0,0 +1,18 @@
+import { ExtensionDataList } from '@teambit/legacy/dist/consumer/config/extension-data';
+import { PathLinuxRelative, PathOsBasedRelative } from '@teambit/legacy/dist/utils/path';
+/**
+ * in-memory representation of the component configuration.
+ */
+export declare class Config {
+    private consumerComponent;
+    constructor(consumerComponent: any);
+    /**
+     * component main file
+     * when loaded from the workspace, it's PathOsBasedRelative. otherwise, PathLinuxRelative.
+     */
+    get main(): PathLinuxRelative | PathOsBasedRelative;
+    /**
+     * configured extensions
+     */
+    get extensions(): ExtensionDataList;
+}

package/dist/dependencies/dependencies.d.ts

@@ -0,0 +1,43 @@
+import { ComponentID } from '@teambit/component-id';
+export declare class DependencyId extends ComponentID {
+}
+export declare class Dependency {
+    id: DependencyId;
+    constructor(id: DependencyId);
+}
+export declare class PackageDependency extends Dependency {
+}
+export declare class ComponentDependency extends Dependency {
+}
+export declare class DependencyList extends Array<Dependency> {
+    /**
+     * Get only package dependencies
+     *
+     * @readonly
+     * @memberof DependencyList
+     */
+    get packages(): PackageDependency[];
+    get components(): ComponentDependency[];
+    static fromArray(dependencies: Dependency[]): DependencyList;
+}
+export declare class Dependencies {
+    runtime: DependencyList;
+    dev: DependencyList;
+    peer: DependencyList;
+    constructor(runtime: DependencyList, dev: DependencyList, peer: DependencyList);
+    private getByEnvironment;
+    /**
+     * Get dependencies needed for development environnement such as runtime, dev and peer
+     *
+     * @returns {DependencyList}
+     * @memberof Dependencies
+     */
+    computeDev(): DependencyList;
+    /**
+     * Get dependencies needed for runtime environnement such as runtime and peer
+     *
+     * @returns {DependencyList}
+     * @memberof Dependencies
+     */
+    computeRuntime(): DependencyList;
+}

package/dist/dependencies/index.d.ts

@@ -0,0 +1 @@
+export { Dependencies } from './dependencies';

package/dist/exceptions/could-not-find-latest.d.ts

@@ -0,0 +1,4 @@
+export declare class CouldNotFindLatest extends Error {
+    constructor(semverArray: string[]);
+    report(): string;
+}

package/dist/exceptions/host-not-found.d.ts

@@ -0,0 +1,12 @@
+export declare class HostNotFound extends Error {
+    /**
+     * name of the host.
+     */
+    private hostName;
+    constructor(
+    /**
+     * name of the host.
+     */
+    hostName: string);
+    toString(): string;
+}

package/dist/exceptions/index.d.ts

@@ -0,0 +1,4 @@
+export { default as NothingToSnap } from './nothing-to-snap';
+export { HostNotFound } from './host-not-found';
+export { CouldNotFindLatest } from './could-not-find-latest';
+export { MainFileNotFound } from './main-file-not-found';

package/dist/exceptions/main-file-not-found.d.ts

@@ -0,0 +1,14 @@
+import { ComponentID } from '@teambit/component-id';
+export declare class MainFileNotFound extends Error {
+    /**
+     * name of the host.
+     */
+    readonly id: ComponentID;
+    readonly mainFile: string;
+    constructor(
+    /**
+     * name of the host.
+     */
+    id: ComponentID, mainFile: string);
+    toString(): string;
+}

package/dist/exceptions/nothing-to-snap.d.ts

@@ -0,0 +1,2 @@
+export default class NothingToSnap extends Error {
+}

package/dist/get-component-opts.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { RouteProps } from 'react-router-dom';
+import type { UseComponentType, Filters } from './ui/use-component';
+export type GetComponentsOptions = {
+    useComponent?: UseComponentType;
+    componentId?: string | (() => string | undefined);
+    useComponentFilters?: () => Filters;
+    path?: string;
+    skipRightSide?: boolean;
+    RightNode?: React.ReactNode;
+    className?: string;
+    routes?: RouteProps[];
+};

package/dist/hash.d.ts

@@ -0,0 +1,4 @@
+/**
+ * type for representing content-addressable filesystem hashes.
+ */
+export type Hash = string;

package/dist/history-graph.d.ts

@@ -0,0 +1,2 @@
+export default class HistoryGraph {
+}

package/dist/host/component-host-model.d.ts

@@ -0,0 +1,7 @@
+import { ComponentModel } from '../ui';
+export declare class ComponentHostModel {
+    readonly name: string;
+    readonly components: ComponentModel[];
+    constructor(name: string, components: ComponentModel[]);
+    static from(data: any): ComponentHostModel;
+}

package/dist/host/index.d.ts

@@ -0,0 +1,2 @@
+export { useComponentHost } from './use-component-host';
+export * from './component-host-model';

package/dist/host/use-component-host.d.ts

@@ -0,0 +1,6 @@
+import { ComponentHostModel } from './component-host-model';
+export declare function useComponentHost(): {
+    host?: undefined;
+} | {
+    host: ComponentHostModel;
+};

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+import { ComponentAspect } from './component.aspect';
+export type { GetComponentsOptions } from './get-component-opts';
+export type { UseComponentType } from './ui/use-component';
+export { useComponentHost } from './host';
+export { Component, InvalidComponent } from './component';
+export { ComponentID } from '@teambit/component-id';
+export { default as ComponentFS } from './component-fs';
+export type { Config as ComponentConfig } from './config';
+export type { ComponentFactory, ResolveAspectsOptions, FilterAspectsOptions, LoadAspectsOptions, } from './component-factory';
+export type { AspectList } from './aspect-list';
+export { AspectEntry, AspectData, ResolveComponentIdFunc } from './aspect-entry';
+export { Snap, SnapProps } from './snap/snap';
+export type { Author } from './snap/author';
+export { Tag, TagProps } from './tag/tag';
+export type { IComponent } from './component-interface';
+export { State } from './state';
+export type { Hash } from './hash';
+export { TagMap } from './tag-map';
+export { ComponentMap } from './component-map';
+export type { ComponentMain } from './component.main.runtime';
+export type { ComponentUI } from './component.ui.runtime';
+export type { Section } from './section';
+export { ComponentContext, ComponentDescriptorContext, useComponentDescriptor } from './ui/context/component-context';
+export type { ComponentProviderProps, ComponentDescriptorProviderProps } from './ui/context';
+export { ComponentProvider, ComponentDescriptorProvider } from './ui/context';
+export { componentFields, componentIdFields, componentOverviewFields } from './ui';
+export type { NavPlugin, ConsumePlugin, MenuNavProps } from './ui/menu';
+export { CollapsibleMenuNav, ComponentMenu, VersionRelatedDropdowns } from './ui/menu';
+export type { RegisteredComponentRoute, ComponentUrlParams } from './component.route';
+export type { ComponentModelProps } from './ui/component-model';
+export { ComponentModel } from './ui/component-model';
+export { TopBarNav } from './ui/top-bar-nav';
+export type { ShowFragment, ShowRow, ShowJSONRow } from './show';
+export { Config } from './config';
+export { useComponent, useIdFromLocation, useComponentLogs, ComponentLogsResult, Filters } from './ui';
+export { ComponentAspect };
+export default ComponentAspect;

package/dist/{preview-1712805335812.js → preview-1712822929999.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.228/dist/component.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.228/dist/component.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.229/dist/component.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.229/dist/component.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/dist/section/index.d.ts

@@ -0,0 +1 @@
+export { Section } from './section';

package/dist/section/section.d.ts

@@ -0,0 +1,11 @@
+import type { LinkProps } from '@teambit/base-react.navigation.link';
+import { RouteProps } from 'react-router-dom';
+export interface Section {
+    route: RouteProps;
+    navigationLink: LinkProps;
+    /**
+     * text to be used in the mobile res dropdown
+     */
+    displayName?: string;
+    order?: number;
+}

package/dist/show/extensions.fragment.d.ts

@@ -0,0 +1,13 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class ExtensionsFragment implements ShowFragment {
+    private renderList;
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: string;
+    }>;
+    json(component: Component): Promise<{
+        title: string;
+        json: any;
+    }>;
+}

package/dist/show/files.fragment.d.ts

@@ -0,0 +1,14 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class FilesFragment implements ShowFragment {
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: string;
+    }>;
+    json(component: Component): Promise<{
+        title: string;
+        json: string[];
+    }>;
+    private getRelativePaths;
+    weight: number;
+}

package/dist/show/id.fragment.d.ts

@@ -0,0 +1,13 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class IDFragment implements ShowFragment {
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: string;
+    }>;
+    json(component: Component): Promise<{
+        title: string;
+        json: string;
+    }>;
+    weight: number;
+}

package/dist/show/index.d.ts

@@ -0,0 +1,8 @@
+export { ShowFragment, ShowRow, JSONRow as ShowJSONRow } from './show-fragment';
+export { ShowCmd } from './show.cmd';
+export { MainFileFragment } from './main-file.fragment';
+export { NameFragment } from './name.fragment';
+export { IDFragment } from './id.fragment';
+export { ScopeFragment } from './scope.fragment';
+export { FilesFragment } from './files.fragment';
+export { ExtensionsFragment } from './extensions.fragment';

package/dist/show/main-file.fragment.d.ts

@@ -0,0 +1,9 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class MainFileFragment implements ShowFragment {
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: any;
+    }>;
+    weight: number;
+}

package/dist/show/name.fragment.d.ts

@@ -0,0 +1,9 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class NameFragment implements ShowFragment {
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: string;
+    }>;
+    weight: number;
+}

package/dist/show/scope.fragment.d.ts

@@ -0,0 +1,10 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class ScopeFragment implements ShowFragment {
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: string;
+    }>;
+    getRow(): void;
+    weight: number;
+}

package/dist/show/show-fragment.d.ts

@@ -0,0 +1,37 @@
+import { Component } from '../component';
+export interface ShowFragment {
+    /**
+     * render a row into the `show` CLI.
+     */
+    renderRow(component: Component): Promise<ShowRow>;
+    /**
+     * return a json output.
+     */
+    json?(component: Component): Promise<JSONRow>;
+    /**
+     * weight is used to determine the position of the fragment
+     * within the `show` table.
+     */
+    weight?: number;
+}
+export interface JSONRow {
+    /**
+     * name of the field.
+     */
+    title: string;
+    /**
+     * json content.
+     * TODO: change this from any to a more structured type (e.g. Serializable).
+     */
+    json: any;
+}
+export interface ShowRow {
+    /**
+     * title of the fragment
+     */
+    title: string;
+    /**
+     * content to render within the fragment.
+     */
+    content: string;
+}

package/dist/show/show.cmd.d.ts

@@ -0,0 +1,26 @@
+import { Command, CommandOptions } from '@teambit/cli';
+import { ComponentMain } from '../component.main.runtime';
+export declare class ShowCmd implements Command {
+    private component;
+    name: string;
+    description: string;
+    alias: string;
+    group: string;
+    arguments: {
+        name: string;
+        description: string;
+    }[];
+    options: CommandOptions;
+    constructor(component: ComponentMain);
+    private getComponent;
+    useLegacy(id: string, json?: boolean, remote?: boolean, compare?: boolean): Promise<string>;
+    report([idStr]: [string], { legacy, remote, compare }: {
+        legacy: boolean;
+        remote: boolean;
+        compare: boolean;
+    }): Promise<string>;
+    json([idStr]: [string], { remote, legacy }: {
+        remote: boolean;
+        legacy: boolean;
+    }): Promise<any>;
+}

package/dist/snap/author.d.ts

@@ -0,0 +1,17 @@
+/**
+ * author type.
+ */
+export type Author = {
+    /**
+     * author full name (for example: "Ran Mizrahi")
+     */
+    displayName: string;
+    /**
+     * author username (for example: "ranm8")
+     */
+    name?: string;
+    /**
+     * author email in a proper format (e.g. "ran@bit.dev")
+     */
+    email: string;
+};

package/dist/snap/index.d.ts

@@ -0,0 +1,2 @@
+export { Author } from './author';
+export { Snap, SnapProps } from './snap';

package/dist/snap/snap.d.ts

@@ -0,0 +1,56 @@
+import { Author } from './author';
+export type SnapProps = {
+    hash: string;
+    timestamp: string;
+    parents: string[];
+    author: Author;
+    message: string;
+};
+/**
+ * `Snap` represents a sealed state of the component in the working tree.
+ */
+export declare class Snap {
+    /**
+     * hash of the snap.
+     */
+    readonly hash: string;
+    /**
+     * date time of the snap.
+     */
+    readonly timestamp: Date;
+    /**
+     * parent snap
+     */
+    readonly parents: string[];
+    /**
+     * author of the component `Snap`.
+     */
+    readonly author: Author;
+    /**
+     * message added by the `Snap` author.
+     */
+    readonly message: string;
+    constructor(
+    /**
+     * hash of the snap.
+     */
+    hash: string, 
+    /**
+     * date time of the snap.
+     */
+    timestamp: Date, 
+    /**
+     * parent snap
+     */
+    parents: string[], 
+    /**
+     * author of the component `Snap`.
+     */
+    author: Author, 
+    /**
+     * message added by the `Snap` author.
+     */
+    message: string);
+    static fromObject(snapObject: SnapProps): Snap;
+    toObject(): SnapProps;
+}