@quicktalog/common 1.23.0 → 1.26.0

package/dist/drizzle/migrations/schema.js

@@ -0,0 +1,145 @@
+import { pgTable, foreignKey, uuid, timestamp, text, pgPolicy, jsonb, integer, unique, serial } from "drizzle-orm/pg-core";
+import { sql } from "drizzle-orm";
+export const prompts = pgTable("prompts", {
+    id: uuid().defaultRandom().primaryKey().notNull(),
+    datetime: timestamp({ withTimezone: true, mode: 'string' }).defaultNow().notNull(),
+    userId: text("user_id"),
+    catalogue: text().notNull(),
+}, (table) => [
+    foreignKey({
+        columns: [table.catalogue],
+        foreignColumns: [catalogues.name],
+        name: "prompts_catalogue_fkey"
+    }).onUpdate("cascade").onDelete("cascade"),
+    foreignKey({
+        columns: [table.userId],
+        foreignColumns: [users.id],
+        name: "prompts_user_id_fkey"
+    }).onUpdate("cascade").onDelete("cascade"),
+]);
+export const users = pgTable("users", {
+    id: text().primaryKey().notNull(),
+    name: text(),
+    createdAt: timestamp("created_at", { withTimezone: true, mode: 'string' }).default(sql `CURRENT_TIMESTAMP`),
+    image: text().default('NULL'),
+    email: text(),
+    planId: text("plan_id"),
+    customerId: text("customer_id"),
+    cookiePreferences: jsonb("cookie_preferences"),
+    consents: jsonb().default({ "refund-policy": true, "privacy-policy": true, "terms-and-conditions": true }).notNull(),
+}, (table) => [
+    pgPolicy("Enable read access for authenticated users to users", { as: "permissive", for: "select", to: ["authenticated"], using: sql `true` }),
+]);
+export const newsletter = pgTable("newsletter", {
+    id: uuid().defaultRandom().primaryKey().notNull(),
+    email: text().notNull(),
+    catalogueId: uuid("catalogue_id").notNull(),
+    ownerId: text("owner_id").notNull(),
+}, (table) => [
+    foreignKey({
+        columns: [table.ownerId],
+        foreignColumns: [users.id],
+        name: "newsletter_owner_id_fkey"
+    }).onUpdate("cascade").onDelete("cascade"),
+]);
+export const ocr = pgTable("ocr", {
+    id: uuid().defaultRandom().primaryKey().notNull(),
+    datetime: timestamp({ withTimezone: true, mode: 'string' }).defaultNow().notNull(),
+    userId: text("user_id"),
+    catalogue: text().notNull(),
+}, (table) => [
+    foreignKey({
+        columns: [table.catalogue],
+        foreignColumns: [catalogues.name],
+        name: "ocr_catalogue_fkey"
+    }).onUpdate("cascade").onDelete("cascade"),
+    foreignKey({
+        columns: [table.userId],
+        foreignColumns: [users.id],
+        name: "ocr_user_id_fkey"
+    }).onUpdate("cascade").onDelete("cascade"),
+]);
+export const subscriptions = pgTable("subscriptions", {
+    subscriptionId: text("subscription_id").primaryKey().notNull(),
+    subscriptionStatus: text("subscription_status").notNull(),
+    priceId: text("price_id"),
+    productId: text("product_id"),
+    scheduledChange: text("scheduled_change"),
+    customerId: text("customer_id").notNull(),
+    createdAt: timestamp("created_at", { withTimezone: true, mode: 'string' }).defaultNow().notNull(),
+    updatedAt: timestamp("updated_at", { withTimezone: true, mode: 'string' }).defaultNow().notNull(),
+}, (table) => [
+    pgPolicy("Enable read access for authenticated users to subscriptions", { as: "permissive", for: "select", to: ["authenticated"], using: sql `true` }),
+]);
+export const productNewsletter = pgTable("product_newsletter", {
+    id: uuid().defaultRandom().notNull(),
+    email: text().notNull(),
+});
+export const jobLogs = pgTable("job_logs", {
+    jobName: text("job_name").notNull(),
+    status: text().notNull(),
+    executionTimeMs: integer("execution_time_ms"),
+    log: text(),
+    createdAt: timestamp("created_at", { withTimezone: true, mode: 'string' }).defaultNow(),
+    id: uuid().defaultRandom().primaryKey().notNull(),
+});
+export const analytics = pgTable("analytics", {
+    date: timestamp({ withTimezone: true, mode: 'string' }).defaultNow().notNull(),
+    currentUrl: text("current_url").notNull(),
+    pageviewCount: integer("pageview_count").notNull(),
+    uniqueVisitors: integer("unique_visitors"),
+    createdAt: timestamp("created_at", { withTimezone: true, mode: 'string' }).defaultNow(),
+    userId: text("user_id").notNull(),
+    id: uuid().defaultRandom().primaryKey().notNull(),
+}, (table) => [
+    foreignKey({
+        columns: [table.userId],
+        foreignColumns: [users.id],
+        name: "analytics_user_id_fkey"
+    }),
+    unique("analytics_unique_entry").on(table.date, table.currentUrl),
+]);
+export const qrConfigs = pgTable("qr_configs", {
+    id: serial().primaryKey().notNull(),
+    catalogue: text().notNull(),
+    config: jsonb().notNull(),
+    createdAt: timestamp("created_at", { mode: 'string' }).defaultNow(),
+    updatedAt: timestamp("updated_at", { mode: 'string' }).defaultNow(),
+}, (table) => [
+    foreignKey({
+        columns: [table.catalogue],
+        foreignColumns: [catalogues.name],
+        name: "qr_configs_catalogue_fkey"
+    }).onUpdate("cascade").onDelete("cascade"),
+    unique("qr_configs_catalogue_key").on(table.catalogue),
+]);
+export const catalogues = pgTable("catalogues", {
+    id: uuid().defaultRandom().primaryKey().notNull(),
+    name: text().notNull(),
+    logo: text(),
+    heading: text(),
+    description: text(),
+    status: text().default('draft').notNull(),
+    source: text().default('builder').notNull(),
+    language: text().default('en').notNull(),
+    currency: text().default('EUR').notNull(),
+    businessType: text("business_type"),
+    tags: text().array().default([""]),
+    content: jsonb().default([]).notNull(),
+    legal: jsonb().default({}).notNull(),
+    appearance: jsonb().default({}).notNull(),
+    contact: jsonb().default({}).notNull(),
+    header: jsonb().default({}).notNull(),
+    footer: jsonb().default({}).notNull(),
+    partners: jsonb().default([]).notNull(),
+    createdAt: timestamp("created_at", { withTimezone: true, mode: 'string' }).defaultNow().notNull(),
+    updatedAt: timestamp("updated_at", { withTimezone: true, mode: 'string' }).defaultNow().notNull(),
+    createdBy: text("created_by").notNull(),
+}, (table) => [
+    foreignKey({
+        columns: [table.createdBy],
+        foreignColumns: [users.id],
+        name: "catalogues_created_by_fkey"
+    }).onUpdate("cascade").onDelete("cascade"),
+    unique("catalogues_name_key").on(table.name),
+]);

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export * from "./constants";
 export * from "./helpers";
 export * from "./types";
-export * from "./pricing";
+export * from "./drizzle";

package/dist/index.js

@@ -1,4 +1,4 @@
 export * from "./constants";
 export * from "./helpers";
 export * from "./types";
-export * from "./pricing";
+export * from "./drizzle";

package/dist/types/catalogue.d.ts

@@ -0,0 +1,112 @@
+import { catalogues } from "../drizzle";
+import { type InferSelectModel } from "drizzle-orm";
+import { AnimationLevel, ContentLayout, FontFamily, FontSize, ShadowLevel, Source, Status, ThemeType } from "./enums";
+import { Update } from "./functions";
+type RawCatalogue = InferSelectModel<typeof catalogues>;
+export type Catalogue = Update<RawCatalogue, {
+    status: Status;
+    source: Source;
+    content: ContentBlock[];
+    legal: Legal;
+    appearance: Appearance;
+    contact: Contact;
+    header: Header;
+    footer: Footer;
+    partners: Partner[];
+}>;
+export interface BaseContentBlock {
+    id: string;
+    order: number;
+}
+export interface CategoryBlock extends BaseContentBlock {
+    type: "category";
+    name: string;
+    layout: ContentLayout;
+    items: Item[];
+    isExpanded: boolean;
+}
+export interface ContainerBlock extends BaseContentBlock {
+    type: "container";
+    name: string;
+    layout: ContentLayout;
+    items: Item[];
+}
+export interface IframeBlock extends BaseContentBlock {
+    type: "iframe";
+    heading?: string;
+    src: string;
+}
+export interface CustomCodeBlock extends BaseContentBlock {
+    type: "custom_code";
+    code: string;
+}
+export interface TextBlock extends BaseContentBlock {
+    type: "text";
+    content: string;
+}
+export type ContentBlock = CategoryBlock | ContainerBlock | IframeBlock | CustomCodeBlock | TextBlock;
+export interface ItemDiscount {
+    isOnDiscount: boolean;
+    discountPercentage: number;
+    discountedPrice: number;
+}
+export interface Item {
+    id: string;
+    order: number;
+    name: string;
+    description: string;
+    image: string;
+    isFree?: boolean;
+    discount?: ItemDiscount;
+    price: number;
+    denominator?: string;
+}
+export interface Legal {
+    legalName: string;
+    termsAndConditions: string;
+    privacyPolicy: string;
+    address: string;
+}
+export interface Appearance {
+    theme: {
+        type: ThemeType;
+        name: string;
+    };
+    style: {
+        contentFontSize: FontSize;
+        fontFamily: FontFamily;
+        borderRadius: number;
+        animation: AnimationLevel;
+        shadow: ShadowLevel;
+    };
+    overlay: {
+        isEnabled: boolean;
+        icon: string;
+    };
+}
+export interface CTAButton {
+    isEnabled: boolean;
+    label: string;
+    url: string;
+}
+export interface Partner {
+    name: string;
+    url: string;
+    description: string;
+}
+export interface Footer {
+    cta: CTAButton;
+    newsletter: boolean;
+    showPartners: boolean;
+}
+export interface Header {
+    cta: CTAButton;
+    emailCta: boolean;
+    phoneCta: boolean;
+}
+export interface Contact {
+    phone: string;
+    email: string;
+    socials: string[];
+}
+export {};

package/dist/types/enums.d.ts

@@ -0,0 +1,10 @@
+export type LimitType = "ai" | "ocr" | "catalogue" | "traffic" | "items" | "categories" | "notFound";
+export type Status = "active" | "inactive" | "draft" | "in preparation" | "error";
+export type Source = "builder" | "ocr_import" | "ai_prompt";
+export type ContentBlockType = "category" | "container" | "iframe" | "custom_code" | "text";
+export type ThemeType = "standard" | "custom";
+export type FontSize = "small" | "medium" | "large";
+export type FontFamily = "mono" | "serif" | "arial" | "monospace";
+export type AnimationLevel = "none" | "minimal" | "medium" | "full";
+export type ShadowLevel = "none" | "low" | "medium" | "high";
+export type ContentLayout = "variant_1" | "variant_2" | "variant_3" | "variant_4";

package/dist/types/enums.js

@@ -0,0 +1 @@
+export {};

package/dist/types/functions.d.ts

@@ -0,0 +1,3 @@
+export type Update<T, U> = {
+    [K in keyof T]: K extends keyof U ? U[K] : T[K];
+};

package/dist/types/functions.js

@@ -0,0 +1 @@
+export {};

package/dist/types/general.d.ts

@@ -0,0 +1,105 @@
+import { users } from "../drizzle";
+import { layouts, themes } from "../constants";
+import { InferSelectModel, Update } from "drizzle-orm";
+export type Usage = {
+    traffic: {
+        pageview_count: number;
+        unique_visitors: number;
+    };
+    ocr: number;
+    prompts: number;
+    catalogues: number;
+};
+export type UserData = User & {
+    usage: Usage;
+    currentPlan: PricingPlan;
+    nextPlan: PricingPlan;
+};
+export type PricingPlan = {
+    id: number;
+    name: string;
+    type: string;
+    priceId: {
+        month: string;
+        year: string;
+    };
+    description: string;
+    features: {
+        support: string;
+        catalogues: number;
+        newsletter: boolean;
+        custom_features: boolean;
+        ocr_ai_import: number;
+        traffic_limit: number;
+        branding: boolean;
+        analytics: string;
+        ai_prompts: number;
+        categories_per_catalogue?: number | "unlimited";
+        items_per_catalogue?: number | "unlimited";
+    };
+    billing_period?: "month" | "year";
+};
+type Item = {
+    key: string;
+    label: string;
+    image: string;
+    description: string;
+};
+export type Theme = Item;
+export type Layout = Item;
+export type ThemeVariant = (typeof themes)[number]["key"];
+export type LayoutVariant = (typeof layouts)[number]["key"];
+export type OverallAnalytics = {
+    totalPageViews: number;
+    totalUniqueVisitors: number;
+    totalServiceCatalogues: number;
+    totalNewsletterSubscriptions: number;
+};
+export type Analytics = {
+    date: string;
+    current_url: string;
+    pageview_count: number;
+    unique_visitors: number;
+};
+export type CookiePreferences = {
+    accepted: boolean;
+    essential: boolean;
+    analytics: boolean;
+    marketing: boolean;
+    timestamp: string;
+    version: string;
+};
+type RawUser = InferSelectModel<typeof users>;
+export type User = Update<RawUser, {
+    cookiePreferences: CookiePreferences;
+}>;
+export type OCRImageData = {
+    id: string;
+    file: File;
+    originalUrl: string;
+    confidence?: number;
+    isProcessed: boolean;
+};
+export interface LanguageOption {
+    code: string;
+    name: string;
+    flag: string;
+}
+export type ContactData = {
+    message: string;
+    email: string;
+    name: string;
+    subject: string;
+};
+export type Currency = {
+    value: string;
+    label: string;
+    symbol: string;
+    locale: string;
+};
+export type AreLimitesReached = {
+    catalogues: boolean;
+    ocr: boolean;
+    prompts: boolean;
+};
+export {};

package/dist/types/general.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./general";
+export * from './catalogue';
+export * from './functions';
+export * from './enums';

package/dist/types/index.js

@@ -0,0 +1,4 @@
+export * from "./general";
+export * from './catalogue';
+export * from './functions';
+export * from './enums';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quicktalog/common",
-  "version": "1.23.0",
+  "version": "1.26.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,13 +12,20 @@
     "prepare": "husky"
   },
   "devDependencies": {
+    "drizzle-kit": "^0.31.8",
     "husky": "^9.1.7",
+    "tsx": "^4.21.0",
     "typescript": "^5.1.6"
   },
   "dependencies": {
     "@types/glob": "^8.0.0",
+    "@types/pg": "^8.16.0",
+    "dotenv": "^17.2.3",
+    "drizzle-orm": "^0.45.1",
     "glob": "^8.1.0",
-    "minimatch": "^9.0.2"
+    "minimatch": "^9.0.2",
+    "pg": "^8.16.3",
+    "postgres": "^3.4.8"
   },
   "publishConfig": {
     "access": "public",

package/dist/pricing.d.ts

@@ -1,2 +0,0 @@
-import { PricingPlan } from "./types";
-export declare const tiers: PricingPlan[];

package/dist/types.d.ts

@@ -1,150 +0,0 @@
-import { layouts, themes } from "./constants";
-export type Status = "active" | "inactive" | "draft" | "in preparation" | "error";
-export type CookiePreferences = {
-    accepted: boolean;
-    essential: boolean;
-    analytics: boolean;
-    marketing: boolean;
-    timestamp: string;
-    version: string;
-};
-export type CategoryItem = {
-    name: string;
-    description: string;
-    price: string;
-    image: string;
-};
-export type Theme = {
-    key: string;
-    label: string;
-    image: string;
-    description: string;
-};
-export type Layout = Theme;
-export type ThemeVariant = (typeof themes)[number]["key"];
-export type LayoutVariant = (typeof layouts)[number]["key"];
-export type CatalogueCategory = {
-    order: number;
-    name: string;
-    layout: LayoutVariant;
-    items: CategoryItem[];
-};
-export type Catalogue = {
-    id?: string;
-    name: string;
-    status: Status;
-    created_by?: string;
-    theme: ThemeVariant;
-    logo?: string;
-    title: string;
-    currency: string;
-    contact?: ContactInfo[];
-    subtitle?: string;
-    services: CatalogueCategory[];
-    partners?: Partner[];
-    legal?: Legal;
-    configuration?: Configuration;
-    created_at?: string;
-    updated_at?: string;
-    source?: string;
-};
-export type CatalogueFormData = Omit<Catalogue, "id" | "created_by" | "">;
-export type Legal = {
-    name?: string;
-    address?: string;
-    terms_and_conditions?: string;
-    privacy_policy?: string;
-};
-export type Partner = {
-    name: string;
-    logo: string;
-    description: string;
-    rating: number;
-    url?: string;
-};
-export type Configuration = {
-    ctaNavbar?: {
-        enabled: boolean;
-        label: string;
-        url: string;
-    };
-    ctaFooter?: {
-        enabled: boolean;
-        label: string;
-        url: string;
-    };
-    newsletter?: {
-        enabled: boolean;
-    };
-};
-export type Analytics = {
-    date: string;
-    current_url: string;
-    pageview_count: number;
-    unique_visitors: number;
-};
-export type User = {
-    id: string;
-    email: string | null;
-    name: string | null;
-    created_at: string;
-    image: string | null;
-    cookie_preferences?: CookiePreferences | null;
-    plan_id: string | null;
-    customer_id: string | null;
-};
-export type OCRImageData = {
-    id: string;
-    file: File;
-    originalUrl: string;
-    confidence?: number;
-    isProcessed: boolean;
-};
-export type ContactInfo = {
-    type: string;
-    value: string;
-};
-export type Usage = {
-    traffic: {
-        pageview_count: number;
-        unique_visitors: number;
-    };
-    ocr: number;
-    prompts: number;
-    catalogues: number;
-};
-export type UserData = User & {
-    usage: Usage;
-    currentPlan: PricingPlan;
-    nextPlan: PricingPlan;
-};
-export type PricingPlan = {
-    id: number;
-    name: string;
-    type: string;
-    priceId: {
-        month: string;
-        year: string;
-    };
-    description: string;
-    features: {
-        support: string;
-        catalogues: number;
-        newsletter: boolean;
-        custom_features: boolean;
-        ocr_ai_import: number;
-        traffic_limit: number;
-        branding: boolean;
-        analytics: string;
-        ai_prompts: number;
-        categories_per_catalogue?: number | "unlimited";
-        items_per_catalogue?: number | "unlimited";
-    };
-    billing_period?: "month" | "year";
-};
-export type ContactData = {
-    message: string;
-    email: string;
-    name: string;
-    subject: string;
-};