@mframework/ui 0.0.1 → 0.0.4

package/dist/types/ui/content/post.d.ts

@@ -0,0 +1,38 @@
+import type { File } from '../system';
+import type { SEO } from '../meta';
+import type { Category, Team } from '.';
+export interface Post {
+    author?: (string | Team) | null;
+    category?: (string | Category) | null;
+    content?: string | null;
+    date_created?: string | null;
+    date_published?: string | null;
+    date_updated?: string | null;
+    id?: string;
+    image?: (string | File) | null;
+    seo?: (string | SEO) | null;
+    slug?: string | null;
+    sort?: number | null;
+    status?: 'draft' | 'published' | 'scheduled' | 'in_review' | 'archived';
+    summary?: string | null;
+    title?: string | null;
+    user_created?: string | null;
+    user_updated?: string | null;
+    links?: string;
+    type?: PostType;
+    details?: string;
+    gallery?: (number | ProjectFile)[];
+    built_with?: {
+        [key: string]: any;
+    } | null;
+    client?: string | null;
+    cost?: string | null;
+    video_url?: string | null;
+}
+export type PostType = 'blog' | 'video' | 'project';
+export interface ProjectFile {
+    directus_files_id?: (string | File) | null;
+    id?: number;
+    project?: (string | File) | null;
+    sort?: number | null;
+}

package/dist/types/ui/content/team.d.ts

@@ -0,0 +1,17 @@
+import type { User, File } from '../system';
+export interface Team {
+    bio?: string | null;
+    date_created?: string | null;
+    date_updated?: string | null;
+    id?: string;
+    image?: (string | File) | null;
+    job_title?: string | null;
+    name?: string | null;
+    social_media?: {
+        [key: string]: any;
+    } | null;
+    sort?: number | null;
+    status?: string;
+    user_created?: string | User | null;
+    user_updated?: string | User | null;
+}

package/dist/types/ui/content/testimonial.d.ts

@@ -0,0 +1,18 @@
+import type { User } from '../system';
+export interface Testimonial {
+    company?: string | null;
+    company_logo?: (string | File) | null;
+    content?: string | null;
+    date_created?: string | null;
+    date_updated?: string | null;
+    id?: string;
+    image?: (string | File) | null;
+    link?: string | null;
+    sort?: number | null;
+    status?: string;
+    subtitle?: string | null;
+    title?: string | null;
+    user_created?: string | User | null;
+    user_updated?: string | User | null;
+    company_info?: string;
+}

package/dist/types/ui/form.d.ts

@@ -0,0 +1,12 @@
+export type FormFieldType = 'text' | 'email' | 'password' | 'number' | 'checkbox' | 'select' | 'textarea';
+export interface FormField {
+    name: string;
+    label: string;
+    type: FormFieldType;
+    placeholder?: string;
+    schema?: unknown;
+    options?: Array<{
+        label: string;
+        value: string;
+    }>;
+}

package/dist/types/ui/help/index.d.ts

@@ -0,0 +1,51 @@
+import type { User } from '../system';
+import type { Form } from '../content';
+export interface HelpArticle {
+    content?: string | null;
+    date_created?: string | null;
+    date_updated?: string | null;
+    help_collection?: (string | HelpCollection) | null;
+    id?: string;
+    owner?: string | User | null;
+    slug?: string | null;
+    sort?: number | null;
+    status?: string;
+    summary?: string | null;
+    title?: string | null;
+    user_created?: string | User | null;
+    user_updated?: string | User | null;
+}
+export interface HelpCollection {
+    description?: string | null;
+    icon?: string | null;
+    id?: string;
+    slug?: string | null;
+    sort?: number | null;
+    title?: string | null;
+    articles?: (string | HelpArticle)[];
+}
+export interface HelpFeedback {
+    comments?: string | null;
+    date_created?: string | null;
+    date_updated?: string | null;
+    id?: string;
+    rating?: number | null;
+    title?: string | null;
+    url?: string | null;
+    user_created?: string | User | null;
+    user_updated?: string | User | null;
+    visitor_id?: string | null;
+}
+export interface Inbox {
+    data?: {
+        [key: string]: any;
+    } | null;
+    date_created?: string | null;
+    date_updated?: string | null;
+    form?: (string | Form) | null;
+    id?: string;
+    sort?: number | null;
+    status?: string;
+    user_created?: string | User | null;
+    user_updated?: string | User | null;
+}

package/dist/types/ui/meta/analytics.d.ts

@@ -0,0 +1,21 @@
+export interface Event {
+    id?: string;
+    key?: string | null;
+    metadata?: {
+        [key: string]: any;
+    } | null;
+    service?: string | null;
+    session?: string | null;
+    timestamp?: string | null;
+    user?: string | null;
+}
+export interface Metric {
+    id?: string;
+    key?: string | null;
+    metadata?: {
+        [key: string]: any;
+    } | null;
+    service?: string | null;
+    timestamp?: string | null;
+    value?: number | null;
+}

package/dist/types/ui/meta/config.d.ts

@@ -0,0 +1,22 @@
+import type { SEO } from '.';
+export interface ChatConfig {
+    /** Would you like to enable the chat / messenger widget on the site? */
+    enabled?: boolean | null;
+    hours?: {
+        [key: string]: any;
+    } | null;
+    id?: string;
+    modules?: {
+        [key: string]: any;
+    } | null;
+    require_email?: string | null;
+}
+export interface PageSettings {
+    [key: string]: any;
+}
+export interface ProjectsSettings {
+    headline?: string | null;
+    id?: string;
+    seo?: (string | SEO) | null;
+    title?: string | null;
+}

package/dist/types/ui/meta/globals.d.ts

@@ -0,0 +1,33 @@
+import type { File } from '../system/index.js';
+export interface Globals {
+    address_country?: string | null;
+    address_locality?: string | null;
+    address_region?: string | null;
+    /** URL for the build / deploy hook that starts a new build */
+    build_hook_url?: string | null;
+    description?: string | null;
+    email?: string | null;
+    id?: string;
+    og_image?: (string | File) | null;
+    phone?: string | null;
+    postal_code?: string | null;
+    routes?: {
+        [key: string]: any;
+    } | null;
+    social_links: {
+        [key: string]: any;
+    } | null;
+    street_address?: string | null;
+    /** What's the website title? */
+    tagline?: string | null;
+    /** What's the website title? */
+    title?: string | null;
+    /** What's is the base url for the site? */
+    url?: string | null;
+    contact?: string;
+    deployment?: string;
+    /** This will be the default metadata used for SEO */
+    seo?: string;
+    social?: string;
+    notice_deployment?: string;
+}

package/dist/types/ui/meta/navigation.d.ts

@@ -0,0 +1,31 @@
+import type { User } from '../system/index.js';
+import type { Page } from '../content/index.js';
+export interface Navigation {
+    date_created?: string | null;
+    date_updated?: string | null;
+    id?: string;
+    status?: string;
+    title?: string | null;
+    user_created?: string | User | null;
+    user_updated?: string | User | null;
+    items?: (string | NavigationItem)[];
+}
+export interface NavigationItem {
+    has_children?: boolean | null;
+    /** Icon that displays in dropdown menus on website. */
+    icon?: string | null;
+    id?: string;
+    /** Label to help User. Displays below the link in dropdown nav menus. */
+    label?: string | null;
+    navigation?: (string | Navigation) | null;
+    open_in_new_tab?: boolean | null;
+    page?: (string | Page) | null;
+    parent?: (string | NavigationItem) | null;
+    sort?: number | null;
+    title?: string | null;
+    type?: string | null;
+    url?: string | null;
+    children?: (string | NavigationItem)[];
+    /** Control the icon and label displayed on the website. */
+    display_details?: string;
+}

package/dist/types/ui/meta/redirect.d.ts

@@ -0,0 +1,12 @@
+import type { User } from '../system';
+export interface Redirect {
+    date_created?: string | null;
+    date_updated?: string | null;
+    id?: string;
+    response_code?: number | null | string;
+    url_new: string;
+    url_old: string;
+    user_created?: string | User | null;
+    user_updated?: string | User | null;
+    notice_redirects?: string;
+}

package/dist/types/ui/meta/seo.d.ts

@@ -0,0 +1,19 @@
+export interface SEO {
+    /** Where should the canonical URL for this entry point to. */
+    canonical_url?: string | null;
+    id?: string;
+    /** This entries meta description. Max 160 characters. */
+    meta_description?: string | null;
+    /** Instruct crawlers not to follow links on this page. */
+    no_follow?: boolean | null;
+    /** Instruct crawlers not to index this entry. */
+    no_index?: boolean | null;
+    /** This item's OG image. Defaults to global site OG image. The recommended size is 1200px x 630px. The image will be focal cropped to this dimension. */
+    og_image?: (string | File) | null;
+    /** How often to instruct search engines to crawl. */
+    sitemap_change_frequency?: string | null;
+    /** Valid values range from 0.0 to 1.0. This value does not affect how your pages are compared to pages on other sites, it only lets the search engines know which pages you deem most important for the crawlers. */
+    sitemap_priority?: number | null;
+    /** This entries title, defaults to title. Max 70 characters including the site name. */
+    title?: string | null;
+}

package/dist/types/ui/os/contact.d.ts

@@ -0,0 +1,22 @@
+import type { User } from '../system';
+import type { OrganizationContact, OsDealContact, OsActivityContact } from '.';
+export interface Contact {
+    id?: string;
+    /** Is this an active contact? */
+    status?: string | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    user?: (string | User) | null;
+    email?: string | null;
+    phone?: string | null;
+    job_title?: string | null;
+    contact_notes?: string | null;
+    organizations?: (string | OrganizationContact)[];
+    os_deals?: (string | OsDealContact)[];
+    activity?: string;
+    activities?: (string | OsActivityContact)[];
+}

package/dist/types/ui/os/conversation.d.ts

@@ -0,0 +1,23 @@
+import type { User } from '../system';
+export interface Conversation {
+    date_created?: string | null;
+    date_updated?: string | null;
+    id?: string;
+    status?: string;
+    title?: string | null;
+    visitor_id?: string | null;
+    item?: string | null;
+    collection?: string | null;
+    messages?: (string | Message)[];
+}
+export interface Message {
+    conversation?: (string | Conversation) | null;
+    date_created?: string | null;
+    date_updated?: string | null;
+    id?: string;
+    text?: string | null;
+    user_created?: (string | User) | null;
+    user_updated?: (string | User) | null;
+    visitor_id?: string | null;
+    contact_id?: string | null;
+}

package/dist/types/ui/os/organization.d.ts

@@ -0,0 +1,51 @@
+import type { User, File } from '../system';
+import type { OsPaymentTerm, Contact } from '.';
+export interface Organization {
+    id?: string;
+    status?: string;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    name?: string | null;
+    website?: string | null;
+    logo?: string | File | null;
+    brand_color?: string | null;
+    organization_notes?: string | null;
+    /** Company email address (sales@company.com) */
+    email?: string | null;
+    ap_contact?: (string | Contact) | null;
+    payment_terms?: (string | OsPaymentTerm) | null;
+    owner?: (string | User) | null;
+    /** Company phone number */
+    phone?: string | null;
+    branding?: string;
+    contacts?: (string | OrganizationContact)[];
+    addresses?: (string | OrganizationAddress)[];
+    billing?: string;
+    stripe_customer_id?: string | null;
+}
+export interface OrganizationAddress {
+    id?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    organization?: (string | Organization) | null;
+    name?: string | null;
+    street_address?: string | null;
+    postal_code?: string | null;
+    /** State (or region if outside US) */
+    address_region?: string | null;
+    address_country?: string | null;
+    /** City */
+    address_locality?: string | null;
+    is_primary_billing?: boolean | null;
+}
+export interface OrganizationContact {
+    id?: string;
+    contacts_id?: (string | Contact) | null;
+    organizations_id?: (string | Organization) | null;
+    sort?: number | null;
+}

package/dist/types/ui/os/os-activity.d.ts

@@ -0,0 +1,26 @@
+import type { User } from '../system';
+import type { Organization, Contact, OsDeal } from '.';
+export interface OsActivity {
+    id?: string;
+    status?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    deal?: (string | OsDeal) | null;
+    activity_type?: string | null;
+    activity_notes?: string | null;
+    name?: string | null;
+    organization?: (string | Organization) | null;
+    start_time?: string | null;
+    end_time?: string | null;
+    due_date?: string | null;
+    assigned_to?: (string | User) | null;
+    contacts?: (string | OsActivityContact)[];
+}
+export interface OsActivityContact {
+    id?: string;
+    os_activities_id?: (string | OsActivity) | null;
+    contacts_id?: (string | Contact) | null;
+}

package/dist/types/ui/os/os-deal.d.ts

@@ -0,0 +1,42 @@
+import type { User } from '../system';
+import type { Organization, Contact, OsProposal, OsActivity } from '.';
+export interface OsDeal {
+    id?: string;
+    status?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    name?: string | null;
+    owner?: (string | User) | null;
+    organization?: (string | Organization) | null;
+    close_date?: string | null;
+    deal_stage?: (string | OsDealStage) | null;
+    next_contact_date?: string | null;
+    deal_value?: number | null;
+    deal_notes?: string | null;
+    comments?: string;
+    proposals?: (string | OsProposal)[];
+    contacts?: (string | OsDealContact)[];
+    activity?: string;
+    activities?: (string | OsActivity)[];
+}
+export interface OsDealContact {
+    id?: string;
+    primary?: boolean | null;
+    os_deals_id?: (string | OsDeal) | null;
+    contacts_id?: (string | Contact) | null;
+    sort?: number | null;
+}
+export interface OsDealStage {
+    id?: string;
+    status?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    name?: string | null;
+    color?: string | null;
+}

package/dist/types/ui/os/os-expense.d.ts

@@ -0,0 +1,21 @@
+import type { File, User } from '../system';
+import type { OsProject, OsInvoiceItem } from '.';
+export interface OsExpense {
+    id?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    category?: string | null;
+    name?: string | null;
+    cost?: number | null;
+    description?: string | null;
+    date?: string | null;
+    file?: (string | File) | null;
+    project?: (string | OsProject) | null;
+    is_billable?: boolean | null;
+    invoice_item?: (string | OsInvoiceItem) | null;
+    status?: string;
+    is_reimbursable?: boolean | null;
+}

package/dist/types/ui/os/os-invoice.d.ts

@@ -0,0 +1,46 @@
+import type { User } from '../system';
+import type { Organization, Contact, OsProject, OsPayment, OsTaxRate, OsExpense, OsItem } from '.';
+export interface OsInvoice {
+    id?: string;
+    status?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    invoice_number?: string | null;
+    due_date?: string | null;
+    reference?: string | null;
+    organization?: (string | Organization) | null;
+    contact?: (string | Contact) | null;
+    issue_date?: string | null;
+    project?: (string | OsProject) | null;
+    subtotal?: number | null;
+    total_tax?: number | null;
+    total?: number | null;
+    amount_paid?: number | null;
+    amount_due?: number | null;
+    payments?: (string | OsPayment)[];
+    line_items?: (string | OsInvoiceItem)[];
+}
+export interface OsInvoiceItem {
+    id?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    invoice?: (string | OsInvoice) | null;
+    line_item_number?: number | null;
+    description?: string | null;
+    tax_rate?: (string | OsTaxRate) | null;
+    tax_amount?: number | null;
+    unit_price?: number | null;
+    quantity?: number | null;
+    line_amount?: number | null;
+    billable_expense?: (string | OsExpense) | null;
+    item?: (string | OsItem) | null;
+    type?: string | null;
+    item_name?: string | null;
+    override_unit_price?: boolean | null;
+}

package/dist/types/ui/os/os-item.d.ts

@@ -0,0 +1,17 @@
+import type { User } from '../system';
+import type { OsTaxRate } from '.';
+export interface OsItem {
+    id?: string;
+    status?: string | null;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    name?: string | null;
+    description?: string | null;
+    unit_price?: number | null;
+    default_tax_rate?: (string | OsTaxRate) | null;
+    icon?: string | null;
+    unit_cost?: number | null;
+}

package/dist/types/ui/os/os-payment.d.ts

@@ -0,0 +1,27 @@
+import type { User } from '../system';
+import type { Organization, Contact, OsInvoice } from '.';
+export interface OsPayment {
+    id?: string;
+    status?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    payment_date?: string | null;
+    amount?: number | null;
+    stripe_payment_id?: string;
+    transaction_fee?: number | null;
+    organization?: (string | Organization) | null;
+    contact?: (string | Contact) | null;
+    invoice?: (string | OsInvoice) | null;
+    metadata?: object | null;
+    receipt_url?: string | null;
+}
+export interface OsPaymentTerm {
+    id?: string;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+}

package/dist/types/ui/os/os-project.d.ts

@@ -0,0 +1,45 @@
+import type { User } from '../system';
+import type { Organization, Contact, OsInvoice, OsTask, OsExpense } from '.';
+export interface OsProject {
+    id?: string;
+    status?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    name?: string | null;
+    organization?: (string | Organization) | null;
+    description?: string | null;
+    owner?: (string | User) | null;
+    start_date?: string | null;
+    due_date?: string | null;
+    expenses?: (string | OsExpense)[];
+    invoices?: (string | OsInvoice)[];
+    contacts?: (string | OsProjectContact)[];
+    billing?: string;
+    tasks?: (string | OsTask)[];
+}
+export interface OsProjectContact {
+    id?: string;
+    os_projects_id?: (string | OsProject) | null;
+    contacts_id?: (string | Contact) | null;
+    sort?: number | null;
+}
+export interface OsProjectFile {
+    id?: string;
+}
+export interface OsProjectTemplate {
+    id?: string;
+    status?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    name?: string | null;
+    tasks?: {
+        [key: string]: any;
+    } | null;
+    description?: string | null;
+}

package/dist/types/ui/os/os-proposal.d.ts

@@ -0,0 +1,61 @@
+import type { User, File } from '../system';
+import type { BlockDivider, BlockFaq, BlockLogocloud, BlockQuote, BlockRichtext, BlockStep, BlockTeam, BlockVideo } from '../blocks';
+import type { Organization, Contact, OsDeal } from '.';
+export interface OsProposal {
+    id?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    name?: string | null;
+    organization?: (string | Organization) | null;
+    deal?: (string | OsDeal) | null;
+    owner?: (string | User) | null;
+    status?: string;
+    contacts?: (string | OsProposalContact)[];
+    activity?: string;
+    approvals?: (string | OsProposalApproval)[];
+    /** This is the content of your proposal */
+    blocks?: (string | OsProposalBlock)[];
+}
+export interface OsProposalApproval {
+    id?: string;
+    status?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    signature_text?: string | null;
+    signature_image?: (string | File) | null;
+    signature_type?: string | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    organization?: string | null;
+    proposal?: (string | OsProposal) | null;
+    email?: string | null;
+    metadata?: {
+        [key: string]: any;
+    } | null;
+    ip_address?: string | null;
+    esignature_agreement?: boolean | null;
+    contact?: (string | Contact) | null;
+}
+export interface OsProposalBlock {
+    id?: string;
+    sort?: number | null;
+    user_created?: (string | User) | null;
+    date_created?: string | null;
+    user_updated?: (string | User) | null;
+    date_updated?: string | null;
+    os_proposals_id?: (string | OsProposal) | null;
+    item?: (string | BlockDivider | BlockFaq | BlockLogocloud | BlockQuote | BlockRichtext | BlockStep | BlockTeam | BlockVideo)[] | null;
+    collection?: string | null;
+}
+export interface OsProposalContact {
+    id?: string;
+    os_proposals_id?: (string | OsProposal) | null;
+    contacts_id?: (string | Contact) | null;
+    sort?: number | null;
+}