@levo-so/core 0.1.49 → 0.1.52

package/dist/types/blog/index.d.ts

@@ -55,13 +55,6 @@ export declare namespace BlogClient {
         created_at: string;
         updated_at: string;
     }
-    interface IBlogResponse {
-        meta: {
-            pages: number;
-            filter_count: number;
-        };
-        data: IPost[];
-    }
     type BlogData = IPost;
     interface OptionParams {
         workspace_id: string;

package/dist/types/collection/lemaCollection.d.ts

@@ -1,33 +1,66 @@
+/**
+ * Represents an icon object used in collections.
+ * @see IIcon
+ */
 import type { IIcon } from "../emoji";
 import type { ICollectionViews } from "../schema/schema";
 import type { ILemaSection } from "./lemaSection";
+/**
+ * Defines the schema structure for a Levo Collection.
+ *
+ * A Levo Collection is a feature of the Levo platform that enables dynamic form rendering using the `@levo-so/react-collection` library.
+ * This interface describes the schema used to generate forms, including sections, fields, and configuration options.
+ * The schema is referenced anywhere a Levo Collection is required in the Levo ecosystem.
+ *
+ * For more details, see the documentation in external/react-collection/docs/readme.md.
+ */
 export interface ILemaCollection {
+    /** Unique identifier for the collection schema. */
     id: string;
+    /** Unique key used as URL slug and can be used to fetch the collection schema. */
     key: string;
+    /** Array of sections that define the structure and fields of the form. */
     sections: ILemaSection[];
+    /** Optional array of views for customizing how the collection is presented. */
     views?: ICollectionViews[];
+    /** Optional workspace ID to which this collection belongs. */
     workspace_id?: string;
+    /** Name of the collection schema. */
     name: string;
+    /** Optional description of the collection schema. */
     description?: string | null;
+    /** Optional icon representing the collection. */
     icon?: IIcon | null;
+    /** Optional field name used as the title for items in the collection. */
     title_field?: string | null;
+    /** Optional field name used for email in the collection. */
+    email_field?: string | null;
+    /** Whether the collection is hidden from the UI. */
     hidden?: boolean;
+    /** Whether the collection is read-only. */
     readonly?: boolean;
+    /** Arbitrary settings for the collection schema. */
     settings?: Record<string, any>;
+    /** Optional module name associated with the collection. */
     module_name?: string | null;
+    /** Optional configuration for actions to perform on submit. */
     on_submit?: Record<string, any>;
+    /** Optional configuration for actions to perform on update. */
     on_update?: Record<string, any>;
+    /** Date or string representing when the collection was created. */
     created_at?: Date | string;
+    /** Date or string representing when the collection was last updated. */
     updated_at?: Date | string;
+    /** Whether the collection allows draft items. */
     allow_draft?: boolean;
 }
-export interface ILemaIndex {
-    name: string;
-    columns: string[];
-    kind: "FULLTEXT" | "UNIQUE";
-}
+/**
+ * Represents a value within a collection, with a unique ID and arbitrary properties.
+ */
 export interface ICollectionValue {
+    /** Unique identifier for the value. */
     id: string;
+    /** Additional arbitrary properties for the value. */
     [x: string]: unknown;
 }
 //# sourceMappingURL=lemaCollection.d.ts.map

package/dist/types/collection/lemaField.d.ts

@@ -3,29 +3,53 @@ import type { IField } from "../schema/field";
 import type { Mandatory } from "../utils";
 import type { ILemaCollection } from "./lemaCollection";
 import type { ILemaCollectionRelationship, ILemaRelationOnDelete } from "./relation";
+/**
+ * Options for configuring the behavior and appearance of a field in a Levo Collection schema.
+ */
 export interface ILemaFieldOptions {
+    /** Whether to link the email field with a member profile. */
     link_with_member_profile?: boolean;
+    /** Key of the referenced collection for collection widget. */
     collection_key?: string;
+    /** ID of the referenced collection for collection widget. */
     collection_id?: string;
+    /** Key of the reference field in the related collection. */
     reference_field_key?: string;
+    /** Key of the label field in the related collection. */
     label_field_key?: string | null;
+    /** Whether the current collection has many connected items. */
     current_have_many_connected?: boolean;
+    /** Whether the connected collection has many current items. */
     connected_have_many_current?: boolean;
+    /** Relationship type or object for the collection widget. */
     relationship?: ILemaCollectionRelationship | string;
+    /** Action to take on delete for the relationship. */
     on_delete?: ILemaRelationOnDelete;
-    /**
-     * Slug Options
-     */
+    /** Slug for the field, used in URLs or as a unique identifier. */
     slug?: string;
+    /** Currency code for currency widget. */
     currency_code?: string;
+    disableCountryGuess?: boolean;
+    /** Location type for location widget. */
     location_type?: string;
+    /** Country for location widget. */
+    country?: string;
+    /** Whether to allow custom input in dropdown widget. */
     custom_input?: boolean;
+    /** The referenced collection object for schema editor. */
     collection?: ILemaCollection | null;
+    /** Whether to disable validation for this field. */
     disableValidation?: boolean;
 }
+/**
+ * Represents a field in a Levo Collection schema, including its configuration and options.
+ */
 export type ILemaField = Mandatory<Omit<IField, "fields" | "options">, "key" | "kind" | "label" | "id"> & {
+    /** Field interface type, determines the widget/component to render. */
     field_interface: (typeof FieldInterfacesList)[number];
+    /** Nested fields, if this field is a group or composite. */
     fields?: ILemaField[];
+    /** Field options for configuring widget behavior. */
     options: ILemaFieldOptions;
 };
 //# sourceMappingURL=lemaField.d.ts.map

package/dist/types/collection/lemaSection.d.ts

@@ -1,6 +1,10 @@
 import type { ISection } from "../schema/schema";
 import type { ILemaField } from "./lemaField";
+/**
+ * Represents a section in a Levo Collection schema, grouping related fields together.
+ */
 export interface ILemaSection extends Omit<ISection, "fields"> {
+    /** Fields contained within this section. */
     fields: ILemaField[];
 }
 //# sourceMappingURL=lemaSection.d.ts.map

package/dist/types/emoji.d.ts

@@ -5,9 +5,10 @@ export interface IEmojiData {
     unicode: string;
 }
 export interface IIconData {
+    id: string;
     label: string;
     tags?: string[];
-    componentName: string;
+    svgCode: string;
 }
 export interface IIconCat {
     name: string;

package/dist/types/event.d.ts

@@ -0,0 +1,211 @@
+import type { IMediaObject, Mandatory } from "@levo-so/core";
+import { IGeocoderLocation } from "./location";
+export declare namespace LevoEvent {
+    interface Root {
+        _id: string;
+        cover_image: IMediaObject | null;
+        contact_email?: string;
+        title: string;
+        kind: "virtual" | "in_person";
+        timing: string;
+        url: string | null;
+        location: IGeocoderLocation | null;
+        starts_at?: string | null;
+        ends_at?: string | null;
+        cadence: string;
+        repeat_every: number;
+        description: string;
+        slug: string;
+        status: "draft" | "canceled" | "published";
+        accept_registration: boolean;
+        max_capacity: number;
+        banners: IMediaObject[];
+        created_at: Date;
+        created_by: string;
+        updated_at: Date;
+        updated_by: string;
+        external_ticketing?: string;
+    }
+    namespace Ticket {
+        interface Root {
+            _id: string;
+            event: string;
+            icon: IMediaObject | null;
+            title: string;
+            description: string;
+            quantity: number | null;
+            starts_at: Date | null;
+            ends_at: Date | null;
+            waitlist_enabled: boolean;
+            requires_approval: boolean;
+            hidden: boolean;
+            allow_to_upgrade: boolean;
+            include_in_upgrade: boolean;
+            enforce_max_quantity: boolean;
+            status: string;
+            offerings: string[];
+            coupons: string[];
+            sale_count: number;
+            currency: string;
+            unit_amount: number;
+            base_price: number;
+            created_at: Date | string;
+            created_by: string;
+            updated_at: Date | string;
+            updated_by: string;
+        }
+        type Create = Pick<Root, "title" | "description" | "quantity" | "starts_at" | "ends_at" | "waitlist_enabled" | "hidden" | "enforce_max_quantity" | "offerings" | "coupons">;
+    }
+    namespace Coupon {
+        interface Root {
+            _id: string;
+            event: string;
+            code: string;
+            kind: string;
+            percent_off: number | null;
+            amount_off: number | null;
+            currency: string;
+            starts_at: Date | null;
+            expires_at: Date | null;
+            max_redemptions: number | null;
+            minimum_amount: number | null;
+            created_at: Date;
+            created_by: string;
+            updated_at: Date;
+            updated_by: string;
+            status: string;
+            tickets: string[];
+        }
+        type Create = Pick<Root, "code" | "kind" | "percent_off" | "amount_off" | "currency" | "starts_at" | "expires_at" | "max_redemptions" | "minimum_amount" | "tickets">;
+        type CreateBulk = Pick<Root, "kind" | "percent_off" | "amount_off" | "currency" | "starts_at" | "expires_at" | "max_redemptions" | "minimum_amount" | "tickets"> & {
+            coupon_count: number;
+            code_length: number;
+        };
+        type Update = Partial<Pick<Root, "code" | "kind" | "percent_off" | "amount_off" | "currency" | "starts_at" | "expires_at" | "max_redemptions" | "minimum_amount" | "tickets">>;
+        type Validate = {
+            base_amount: number;
+            sale_amount: number;
+            discountable_amount: number;
+            discount: number;
+        };
+    }
+    namespace Offering {
+        interface Root {
+            _id: string;
+            event: string;
+            title: string;
+            description: string;
+            enabled: boolean;
+            checkin_count: number;
+            tickets: string[];
+            attendees: string[];
+            created_at: Date;
+            created_by: string;
+            updated_at: Date;
+            updated_by: string;
+        }
+        type Create = Pick<Root, "title" | "description" | "enabled" | "tickets">;
+        type Update = Partial<Pick<Root, "title" | "description" | "enabled" | "tickets">>;
+    }
+    namespace Attendee {
+        interface Root {
+            _id: string;
+            public_id: string;
+            name: string;
+            email: string;
+            mobile: string | null;
+            event: string;
+            booking: Booking.Root;
+            ticket: Pick<LevoEvent.Ticket.Root, "_id" | "title" | "currency" | "quantity" | "status" | "unit_amount">;
+            price: string;
+            account: string | null;
+            status: string;
+            created_at: Date;
+            updated_at: Date;
+        }
+    }
+    namespace Booking {
+        interface Root {
+            _id: string;
+            slug: string;
+            public_id: string;
+            quantity: number;
+            unit_amount: number;
+            discount: number;
+            currency: string;
+            payment_link: string | null;
+            account: string | null;
+            event: string;
+            coupon: string | null;
+            code: string | null;
+            status: string;
+            paid: boolean;
+            info: Record<string, any>;
+            qr_image: IMediaObject & {
+                width: number;
+                height: number;
+            };
+            created_at: Date;
+            updated_at: Date;
+            attendees: LevoEvent.Attendee.Root[];
+        }
+        type Create = Omit<Pick<Root, "event" | "coupon">, "attendees"> & {
+            attendees: Mandatory<LevoEvent.Attendee.Root, "name" | "ticket" | "email">;
+        };
+    }
+    namespace Series {
+        interface Root {
+            _id: string;
+            slug: string;
+            name: string;
+            description: string;
+            cover_image: string | null;
+            status: "published" | string;
+            created_at: string;
+            updated_at: string;
+            events: any[];
+        }
+        interface Create {
+            name: string;
+        }
+        interface Update {
+            name: string;
+        }
+    }
+}
+/**
+ * Main Object
+ */
+export interface IAttendee {
+    checkin_at?: Date | null;
+    _id: string;
+    public_id: string;
+    name: string;
+    email: string;
+    mobile: string | null;
+    event: string;
+    booking: string;
+    ticket: Record<string, string>;
+    price: string;
+    account?: any;
+    status: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface IBooking {
+    _id: string;
+    public_id: string;
+    quantity: number;
+    unit_amount: number;
+    event: string;
+    currency: string;
+    account: string;
+    coupon?: null;
+    status: string;
+    paid: boolean;
+    discount: number;
+    created_at: string;
+    updated_at: string;
+    attendees?: IAttendee[];
+}
+//# sourceMappingURL=event.d.ts.map

package/dist/types/index.d.ts

@@ -8,4 +8,7 @@ export * from "./levo-query";
 export * from "./media";
 export * from "./query";
 export * from "./utils";
+export * from "./workspace";
+export * from "./event";
+export * from "./location";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/location.d.ts

@@ -0,0 +1,6 @@
+export interface IGeocoderLocation extends Partial<google.maps.places.PlaceResult> {
+    place_name: string;
+    latitude?: number;
+    longitude?: number;
+}
+//# sourceMappingURL=location.d.ts.map

package/dist/types/membership/index.d.ts

@@ -1,7 +1,5 @@
 import type { LevoOAuthProviderList } from "../../constants/oauthProvider";
-import type { ILevoError } from "../../utils/LevoError";
 import type { IMediaObject } from "../media";
-import type { IResponseSingle } from "../query";
 export declare namespace ILevoMembership {
     interface sub_account_oauth_credentials {
         provider: string;
@@ -20,6 +18,8 @@ export declare namespace ILevoMembership {
         display_email: string;
         reducted_email: string;
         email_verified: boolean;
+        email_verified_at: string | null;
+        verified_at: string | null;
         mobile: string | null;
         reducted_mobile: string | null;
         mobile_verified: boolean;
@@ -175,21 +175,6 @@ export declare namespace ILevoMembership {
             password: string;
         };
     }
-    export namespace Response {
-        type Error = {
-            status: false;
-            content: ILevoError;
-        };
-        type ListOAuthURLs = IResponseSingle<ILevoMembership.OAuthURLList>;
-        type SignOut = IResponseSingle<ILevoMembership.Account>;
-        type GetMe = IResponseSingle<ILevoMembership.Account>;
-        type RequestOtp = IResponseSingle<Pick<ILevoMembership.Otp, "_id" | "content">>;
-        type RequestMagicLink = IResponseSingle<Pick<ILevoMembership.Otp, "_id" | "content">>;
-        type SignInWithOtp = IResponseSingle<ILevoMembership.Account>;
-        type SignInWithPassword = IResponseSingle<ILevoMembership.Account>;
-        type SignUpWithPassword = IResponseSingle<ILevoMembership.Account>;
-        type UpdateMe = IResponseSingle<ILevoMembership.Account>;
-    }
     export {};
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/types/query.d.ts

@@ -22,18 +22,22 @@ export interface IResponseMyCategory<T = Record<string, unknown>> {
         data: T[];
     };
 }
-export type IResponseError<T = Record<string, unknown>> = {
+export interface IFieldError {
+    param: string;
+    message: string;
+}
+export interface IErrorContent {
+    status: number;
+    code: string;
+    title: string;
+    description: string;
+    type?: string;
+    errors?: IFieldError[];
+}
+export interface IResponseError {
     status: false;
-    errors?: T[];
-    content?: {
-        status: number;
-        code: string;
-        title: string;
-        description: string;
-        type: string;
-        "request-id": string;
-    } & T;
-};
+    content: IErrorContent;
+}
 export type IFilter = Record<string, unknown>;
 export type IErrorParams = {
     message: string;

package/dist/types/schema/field.d.ts

@@ -1,28 +1,56 @@
 import type { FieldInterfacesList, FieldKindList } from "../../constants";
+/**
+ * Defines the structure for a field in a generic schema system. Levo Collection builds its own types on top of this, so this type is not used directly.
+ */
 export interface IField {
+    /** Unique identifier for the field. */
     id: string;
+    /** Unique key for the field, used for referencing. */
     key: string;
+    /** The kind/type of the field (e.g., text, number, date). */
     kind: (typeof FieldKindList)[number];
-    field_interface: (typeof FieldInterfacesList)[number] | "HeadingWidget" | "ButtonWidget" | "ImageWidget" | "MultiImageWidget" | "TypographyWidget" | "LayoutWidget" | "RepeatableWidget" | "TitleWidget" | "CardWidget" | "LinkWidget";
+    /** The widget/component type used to render this field. */
+    field_interface: (typeof FieldInterfacesList)[number] | "HeadingWidget" | "ButtonWidget" | "ImageWidget" | "MultiImageWidget" | "TypographyWidget" | "LayoutWidget" | "RepeatableWidget" | "TitleWidget" | "CardWidget" | "LinkWidget" | "IframeWidget";
+    /** Label for the field, displayed in the UI. */
     label: string;
+    /** Helper text shown below the field. */
     helper_text?: string;
+    /** Placeholder text for the field input. */
     placeholder?: string;
+    /** Default value for the field. */
     default_value?: any;
+    /** Whether the field is read-only. */
     readonly?: boolean;
+    /** Nested fields, if this field is a group or composite. */
     fields?: IField[];
+    /** Additional options for configuring the field. */
     options?: Record<string, any>;
+    /** Whether the field is hidden from the UI. */
     hidden?: boolean;
+    /** Whether the field is editable. */
     editable?: boolean;
+    /** Whether the field is required. */
     required?: boolean;
+    /** Whether the field value must be unique. */
     unique?: boolean;
+    /** Minimum value or length for the field. */
     min?: string | number | null;
+    /** Maximum value or length for the field. */
     max?: string | number | null;
+    /** Allowed formats for the field value. */
     formats?: string[];
+    /** Allowed values for the field (for select/dropdown fields). */
     values?: any[];
+    /** */
     created_at?: string;
+    /** */
     updated_at?: string;
 }
+/**
+ * Used for making partial updates to fields, especially nested fields. This type is not used directly in most Levo Collection code, but Levo Collection types are based on it.
+ */
 export interface IFieldUpdate extends Omit<IField, "fields"> {
+    /** Nested fields to update, provided as partials. */
     fields: Partial<IField>[];
 }
 //# sourceMappingURL=field.d.ts.map

package/dist/types/schema/schema.d.ts

@@ -1,29 +1,58 @@
 import type { IIcon } from "../emoji";
 import type { IField } from "./field";
+/**
+ * Defines the basic structure for a collection schema, including its sections, fields, and configuration. Levo Collection uses its own types built on top of this, so this type is not used directly.
+ */
 export interface ISchema {
+    /** Unique identifier for the schema. */
     id: string;
+    /** Name of the schema. */
     name: string;
+    /** Description of the schema. */
     description: string;
+    /** Unique key for referencing the schema. */
     key: string;
+    /** Sections that make up the schema, each containing fields. */
     sections: ISection[];
+    /** Field key used as the title for items in the schema. */
     title_field: string;
+    /** */
     cover_image_field?: string;
+    /** Icon representing the schema. */
     icon: null | IIcon;
+    /** */
     created_at?: string;
+    /** */
     module_name?: string;
+    /** Views for customizing how the schema is presented. */
     views?: ICollectionViews[];
 }
+/**
+ * Defines the structure for a view configuration in a collection schema. Levo Collection uses its own types built on top of this, so this type is not used directly in most Levo Collection code.
+ */
 export interface ICollectionViews {
+    /** Unique identifier for the view. */
     id: string;
+    /** Slug for the view, used in URLs. */
     slug: string;
+    /** Title of the view. */
     title: string;
 }
+/**
+ * Defines the structure for a section in a schema, grouping related fields together. Levo Collection uses its own types built on top of this, so this type is not used directly in most Levo Collection code.
+ */
 export interface ISection {
+    /** Unique identifier for the section. */
     id: string;
+    /** Label for the section, displayed in the UI. */
     label: string;
+    /** Unique key for referencing the section. */
     key: string;
+    /** Helper text for the section. */
     helper_text: string;
+    /** Whether the section is hidden from the UI. */
     hidden: boolean;
+    /** Fields contained within this section. */
     fields: IField[];
 }
 //# sourceMappingURL=schema.d.ts.map