@garchicms/garchi-node-sdk 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,384 @@
+interface PaginationLinks {
+    first: string;
+    last: string;
+    prev: string | null;
+    next: string | null;
+}
+interface PaginationMeta {
+    current_page: number;
+    from: number;
+    last_page: number;
+    links: Array<{
+        url: string | null;
+        label: string;
+        active: boolean;
+    }>;
+    path: string;
+    per_page: number;
+    to: number;
+    total: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    links: PaginationLinks;
+    meta: PaginationMeta;
+}
+interface GetPageParams {
+    space_uid: string;
+    slug: string;
+    lang?: string;
+    mode?: "draft" | "live";
+}
+type GarchiPage = {
+    id: string;
+    title: string;
+    slug: string;
+    description: string;
+    sections: GarchiSection[];
+};
+type SectionPropType = "text" | "longtext" | "media" | "richtext" | "select";
+interface SectionTemplateProp {
+    key: string;
+    type: SectionPropType;
+    allowed_values?: string;
+}
+interface SectionTemplate {
+    name: string;
+    description?: string;
+    prev_name?: string;
+    props?: SectionTemplateProp[];
+}
+interface CreateOrUpdateSectionTemplateParams {
+    space_uid: string;
+    section_templates: SectionTemplate[];
+}
+type GarchiSection = {
+    id: string;
+    name: string;
+    description?: string;
+    props: {
+        [key: string]: unknown;
+    };
+    children: GarchiSection[];
+    order: number;
+};
+type GarchiReviewCreate = {
+    item_id: number;
+    rating: number;
+    review_body: string;
+    user_email?: string;
+    user_name?: string;
+    parent_id?: number;
+};
+type GarchiReviewUpdate = {
+    review_id: number;
+    review_body?: string;
+    rating: number;
+};
+type GarchiReactionCreate = {
+    reaction: string;
+    user_identifier: string;
+    review_id?: number;
+    item_id?: number;
+    reaction_for: "review" | "item";
+};
+type GarchiReaction = {
+    reaction_id: string;
+    reaction: string;
+    user_identifier: string;
+    created_at: string;
+    updated_at: string;
+};
+type GarchiReview = {
+    review_id: number;
+    review_body: string;
+    rating: number;
+    guest: null;
+    user: {
+        fname: string;
+        lname: string;
+    };
+    item_id: number;
+    reviewed_at: string;
+    replies?: GarchiReview[];
+    reactions?: GarchiReaction[];
+};
+type GarchiCategory = {
+    id: number;
+    name: string;
+};
+type GarchiAttributeOption = {
+    id: number;
+    name: string;
+    price: number;
+};
+type GarchiAttribute = {
+    id: number;
+    name: string;
+    min: string;
+    options: GarchiAttributeOption[];
+};
+type GarchiSpace = {
+    uid: string;
+    name: string;
+    logo_url?: string;
+    number_of_items: number;
+};
+type GarchiSpaceCreate = {
+    name: string;
+    logo?: File;
+};
+type GarchiSpaceAPIResponse = PaginatedResponse<GarchiSpace>;
+type GarchiItemMeta = {
+    id?: number;
+    key: string;
+    value: string;
+    type: string;
+};
+type GarchiItem = {
+    item_id: number;
+    slug: string;
+    sku?: string;
+    name: string;
+    stock?: number;
+    categories: GarchiCategory[];
+    price?: number;
+    external_link?: string;
+    scratched_price?: number | null;
+    one_liner?: string;
+    description?: string;
+    delivery_type?: string;
+    main_image?: string;
+    other_images?: string[];
+    attributes?: GarchiAttribute[];
+    space?: GarchiSpace;
+    avg_rating?: number | null;
+    scheduled_for?: string | null;
+    item_meta?: GarchiItemMeta[];
+    reactions?: GarchiReaction[];
+    created?: string;
+    updated?: string;
+};
+type GarchiItemAPIResponse = PaginatedResponse<GarchiItem>;
+type GarchiCategoryAPIResponse = PaginatedResponse<GarchiCategory>;
+type GarchiAsset = {
+    id: string;
+    path: string;
+    size: string;
+    type: string;
+};
+type GarchiCMSInitOptions = {
+    api_key?: string;
+    headers?: Record<string, string | number | boolean>;
+};
+interface CreateDataItemParams {
+    space_uid: string;
+    name: string;
+    categories: number[];
+    sku?: string;
+    stock?: number;
+    price?: number;
+    scratched_price?: number;
+    detail_description?: string;
+    external_url?: string;
+    slug?: string;
+}
+interface DeleteDataItemParams {
+    item_id: number;
+    space_uid: string;
+}
+interface UpdateDataItemParams {
+    item_id: number;
+    space_uid: string;
+    name?: string;
+    sku?: string;
+    stock?: number;
+    categories?: number[];
+    price?: number;
+    scratched_price?: number;
+    detail_description?: string;
+    external_url?: string;
+    make_public?: boolean;
+    slug?: string;
+}
+type MetaType = "string" | "array" | "url" | "object" | "numeric" | "email" | "date";
+interface MetaInfo {
+    key: string;
+    type: MetaType;
+    value: string;
+}
+interface CreateMetaInfoParams {
+    item_id: number;
+    meta: MetaInfo[];
+}
+interface DeleteMetaInfoParams {
+    meta_id: number;
+    item_id: number;
+    space_uid: string;
+}
+interface UpdateMetaInfoParams {
+    meta_id: number;
+    item_id: number;
+    key?: string;
+    type?: MetaType;
+    value?: string;
+}
+interface PaginateQueryParams {
+    size?: number;
+    page?: number;
+}
+interface ItemsQueryParams extends PaginateQueryParams {
+    order_key?: "name" | "price" | "created" | `meta.${string}`;
+    order_by?: "asc" | "desc";
+    reactions?: "include" | "exclude";
+    description?: "include" | "exclude";
+}
+interface GetItemsBySpaceParams extends ItemsQueryParams {
+    uid: string;
+}
+interface SemanticSearchParams {
+    q: string;
+    threshold?: number;
+    reactions?: "include" | "exclude";
+    description?: "include" | "exclude";
+}
+interface GetFeaturedItemsParams {
+    reactions?: "include" | "exclude";
+    description?: "include" | "exclude";
+}
+interface GetItemParams {
+    item: string | number;
+    reactions?: "include" | "exclude";
+}
+interface GetAllItemsParams extends ItemsQueryParams {
+    search_keyword?: string;
+}
+interface FilterItemsBodyParams {
+    spaces?: string[];
+    categories?: number[];
+    priceOrder?: "low-high" | "high-low";
+    size?: number;
+}
+interface FilterItemsParams {
+    query?: ItemsQueryParams;
+    body: FilterItemsBodyParams;
+}
+type MetaFilterOperator = "equals" | "in" | "like" | "gte" | "lte";
+interface MetaFilter {
+    key: string;
+    value: string | number | (string | number)[];
+    operator: MetaFilterOperator;
+}
+interface FilterItemsByMetaBodyParams {
+    meta_filters: MetaFilter[];
+}
+interface FilterItemsByMetaParams {
+    query?: ItemsQueryParams;
+    body: FilterItemsByMetaBodyParams;
+}
+interface GetItemsByIdsBodyParams {
+    item_ids: (number | string)[];
+}
+interface GetItemsByIdsParams {
+    query?: ItemsQueryParams;
+    body: GetItemsByIdsBodyParams;
+}
+interface CreateCategoryParams {
+    category: string;
+    space_uid: string;
+}
+interface DeleteCategoryParams {
+    category_id: number;
+    space_uid: string;
+}
+interface UpdateCategoryParams extends CreateCategoryParams {
+    category_id: number;
+}
+type DatasetType = "items" | "categories" | "reviews";
+type ItemFields = "item_id" | "name" | "slug" | "description" | "categories" | "ratings" | "price" | "created";
+type CategoryFields = "category_id" | "category_name";
+type ReviewFields = "review_id" | "item_id" | "rating" | "review" | "created";
+type ConditionType = "eq" | "gte" | "lte" | "gt" | "lt" | "like" | "in" | "not_eq" | "not_in";
+type LogicType = "and" | "or";
+interface CompoundQueryBody {
+    dataset: DatasetType;
+    fields: string[];
+    conditions: ConditionType[];
+    values: (string | number)[];
+    logic?: LogicType[];
+}
+
+declare class APIClient {
+    client: Axios.AxiosInstance;
+    constructor(options: GarchiCMSInitOptions | null);
+}
+
+declare class Category extends APIClient {
+    create(params: CreateCategoryParams): Promise<GarchiCategory>;
+    delete(params: DeleteCategoryParams): Promise<string>;
+    update(params: UpdateCategoryParams): Promise<string>;
+    getAll(): Promise<GarchiCategory[]>;
+}
+
+declare class CompoundQuery extends APIClient {
+    query(body: CompoundQueryBody, params: ItemsQueryParams): Promise<GarchiItemAPIResponse | GarchiCategoryAPIResponse | PaginatedResponse<GarchiReview>>;
+}
+
+declare class DataItem extends APIClient {
+    create(params: CreateDataItemParams): Promise<GarchiItem>;
+    delete(params: DeleteDataItemParams): Promise<string>;
+    update(params: UpdateDataItemParams): Promise<string>;
+    createMetaInfo(params: CreateMetaInfoParams): Promise<GarchiItemMeta[]>;
+    deleteMetaInfo(params: DeleteMetaInfoParams): Promise<string>;
+    updateMetaInfo(params: UpdateMetaInfoParams): Promise<string>;
+    getBySpace(params: GetItemsBySpaceParams): Promise<GarchiItemAPIResponse>;
+    semanticSearch(params: SemanticSearchParams): Promise<GarchiItem[]>;
+    featured(params: GetFeaturedItemsParams): Promise<GarchiItemAPIResponse>;
+    get(params: GetItemParams): Promise<GarchiItem>;
+    getAll(params: GetAllItemsParams): Promise<GarchiItemAPIResponse>;
+    filter(params: FilterItemsParams): Promise<GarchiItem[]>;
+    filterByMeta(params: FilterItemsByMetaParams): Promise<GarchiItem[]>;
+    getByIds(params: GetItemsByIdsParams): Promise<GarchiItemAPIResponse>;
+}
+
+declare class Headless extends APIClient {
+    getAsset(file_name: string, space_uid: string): Promise<GarchiAsset>;
+    getPage(params: GetPageParams): Promise<GarchiPage>;
+    createOrUpdateSectionTemplates(params: CreateOrUpdateSectionTemplateParams): Promise<string>;
+}
+
+declare class Reaction extends APIClient {
+    manage(params: GarchiReactionCreate): Promise<GarchiReaction>;
+}
+
+declare class Review extends APIClient {
+    create(params: GarchiReviewCreate): Promise<GarchiReview>;
+    update(params: GarchiReviewUpdate): Promise<string>;
+    delete(review_id: number): Promise<string>;
+    getByItem(item_id: number | string, queryParams: PaginateQueryParams): Promise<PaginatedResponse<GarchiReview>>;
+}
+
+declare class Space extends APIClient {
+    categories(space_uid: string): Promise<GarchiCategory[]>;
+    getAll(params: PaginateQueryParams): Promise<GarchiSpaceAPIResponse>;
+    get(space_uid: string): Promise<GarchiSpace>;
+    create(params: GarchiSpaceCreate): Promise<GarchiSpace>;
+    update(space_uid: string, params: {
+        name?: string;
+        logo?: File;
+    }): Promise<string>;
+    delete(space_uid: string): Promise<string>;
+}
+
+declare class GarchiCMS {
+    dataItem: DataItem;
+    category: Category;
+    space: Space;
+    review: Review;
+    headless: Headless;
+    reaction: Reaction;
+    compoundQuery: CompoundQuery;
+    constructor(options: GarchiCMSInitOptions);
+}
+
+export { type CategoryFields, type CompoundQueryBody, type ConditionType, type CreateCategoryParams, type CreateDataItemParams, type CreateMetaInfoParams, type CreateOrUpdateSectionTemplateParams, type DatasetType, type DeleteCategoryParams, type DeleteDataItemParams, type DeleteMetaInfoParams, type FilterItemsBodyParams, type FilterItemsByMetaBodyParams, type FilterItemsByMetaParams, type FilterItemsParams, type GarchiAsset, type GarchiAttribute, type GarchiAttributeOption, type GarchiCMSInitOptions, type GarchiCategory, type GarchiCategoryAPIResponse, type GarchiItem, type GarchiItemAPIResponse, type GarchiItemMeta, type GarchiPage, type GarchiReaction, type GarchiReactionCreate, type GarchiReview, type GarchiReviewCreate, type GarchiReviewUpdate, type GarchiSection, type GarchiSpace, type GarchiSpaceAPIResponse, type GarchiSpaceCreate, type GetAllItemsParams, type GetFeaturedItemsParams, type GetItemParams, type GetItemsByIdsBodyParams, type GetItemsByIdsParams, type GetItemsBySpaceParams, type GetPageParams, type ItemFields, type ItemsQueryParams, type LogicType, type MetaFilter, type MetaFilterOperator, type MetaInfo, type MetaType, type PaginateQueryParams, type PaginatedResponse, type PaginationLinks, type PaginationMeta, type ReviewFields, type SectionPropType, type SectionTemplate, type SectionTemplateProp, type SemanticSearchParams, type UpdateCategoryParams, type UpdateDataItemParams, type UpdateMetaInfoParams, GarchiCMS as default };