@quicktalog/common 1.0.0 → 1.1.0

package/.github/workflows/publish.yaml

@@ -0,0 +1,31 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main # or 'release' if you prefer
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: "https://registry.npmjs.org/"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build (optional)
+        run: npm run build --if-present
+
+      - name: Publish package
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.husky/pre-commit

@@ -0,0 +1,3 @@
+npm version minor
+git add .
+git commit -m "updated version"

package/dist/helpers.js

@@ -29,4 +29,3 @@ const generateUniqueSlug = (name) => {
     return slug;
 };
 exports.generateUniqueSlug = generateUniqueSlug;
-// npm publish --access public

package/dist/types.d.ts

@@ -49,12 +49,6 @@ export type Catalogue = {
     source?: string;
 };
 export type ServicesFormData = Omit<Catalogue, "id" | "created_by" | "">;
-export type Service = {
-    name: string;
-    image: string;
-    price: number | string;
-    description: string;
-};
 export type Legal = {
     name?: string;
     address?: string;

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@quicktalog/common",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "prepare": "husky install"
   },
   "devDependencies": {
+    "husky": "^9.1.7",
     "typescript": "^5.1.6"
   },
   "dependencies": {

package/src/helpers.ts

@@ -1,35 +1,35 @@
-export async function fetchImageFromUnsplash(query: string): Promise<string> {
-	try {
-		const res = await fetch(
-			`https://api.unsplash.com/search/photos?page=1&per_page=1&query=${encodeURIComponent(query)}`,
-			{
-				headers: {
-					Authorization: `Client-ID ${process.env.UNSPLASH_API_KEY}`,
-				},
-			},
-		);
-
-		const data = await res.json();
-
-		if (data?.results?.[0]?.urls?.regular) {
-			return data.results[0].urls.regular;
-		}
-	} catch (err) {
-		console.error(`Failed to fetch image for "${query}":`, err);
-	}
-
-	return "https://static1.squarespace.com/static/5898e29c725e25e7132d5a5a/58aa11bc9656ca13c4524c68/58aa11e99656ca13c45253e2/1487540713345/600x400-Image-Placeholder.jpg?format=original";
-}
-
-export const generateUniqueSlug = (name: string) => {
-	const slug = name
-		.toLowerCase()
-		.trim()
-		.replace(/\s+/g, "-")
-		.replace(/-+/g, "-")
-		.replace(/^-|-$/g, "");
-
-	return slug;
-};
-
-// npm publish --access public
+export async function fetchImageFromUnsplash(query: string): Promise<string> {
+  try {
+    const res = await fetch(
+      `https://api.unsplash.com/search/photos?page=1&per_page=1&query=${encodeURIComponent(
+        query
+      )}`,
+      {
+        headers: {
+          Authorization: `Client-ID ${process.env.UNSPLASH_API_KEY}`,
+        },
+      }
+    );
+
+    const data = await res.json();
+
+    if (data?.results?.[0]?.urls?.regular) {
+      return data.results[0].urls.regular;
+    }
+  } catch (err) {
+    console.error(`Failed to fetch image for "${query}":`, err);
+  }
+
+  return "https://static1.squarespace.com/static/5898e29c725e25e7132d5a5a/58aa11bc9656ca13c4524c68/58aa11e99656ca13c45253e2/1487540713345/600x400-Image-Placeholder.jpg?format=original";
+}
+
+export const generateUniqueSlug = (name: string) => {
+  const slug = name
+    .toLowerCase()
+    .trim()
+    .replace(/\s+/g, "-")
+    .replace(/-+/g, "-")
+    .replace(/^-|-$/g, "");
+
+  return slug;
+};

package/src/types.ts

@@ -3,26 +3,26 @@ import { layouts, themes } from "./constants";
 export type Status = "active" | "inactive" | "draft";
 
 export type CookiePreferences = {
-	accepted: boolean;
-	essential: boolean;
-	analytics: boolean;
-	marketing: boolean;
-	timestamp: string;
-	version: string;
+  accepted: boolean;
+  essential: boolean;
+  analytics: boolean;
+  marketing: boolean;
+  timestamp: string;
+  version: string;
 };
 
 export type CategoryItem = {
-	name: string;
-	description: string;
-	price: number;
-	image: string;
+  name: string;
+  description: string;
+  price: number;
+  image: string;
 };
 
 export type Theme = {
-	key: string;
-	label: string;
-	image: string;
-	description: string;
+  key: string;
+  label: string;
+  image: string;
+  description: string;
 };
 
 export type Layout = Theme;
@@ -31,143 +31,136 @@ 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[];
+  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;
+  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 ServicesFormData = Omit<Catalogue, "id" | "created_by" | "">;
 
-export type Service = {
-	name: string;
-	image: string;
-	price: number | string;
-	description: string;
-};
-
 export type Legal = {
-	name?: string;
-	address?: string;
-	terms_and_conditions?: string;
-	privacy_policy?: string;
+  name?: string;
+  address?: string;
+  terms_and_conditions?: string;
+  privacy_policy?: string;
 };
 
 export type Partner = {
-	name: string;
-	logo: string;
-	description: string;
-	rating: number;
-	url?: string;
+  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;
-	};
+  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;
+  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;
+  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;
+  id: string;
+  file: File;
+  originalUrl: string;
+  confidence?: number;
+  isProcessed: boolean;
 };
 
 export type ContactInfo = {
-	type: string;
-	value: string;
+  type: string;
+  value: string;
 };
 
 export type Usage = {
-	traffic: { pageview_count: number; unique_visitors: number };
-	ocr: number;
-	prompts: number;
-	catalogues: number;
+  traffic: { pageview_count: number; unique_visitors: number };
+  ocr: number;
+  prompts: number;
+  catalogues: number;
 };
 
 export type UserData = User & {
-	usage: Usage;
-	currentPlan: PricingPlan;
-	nextPlan: PricingPlan;
+  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";
+  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;
+  message: string;
+  email: string;
+  name: string;
+  subject: string;
 };