Talisik URL Shortener - JavaScript/TypeScript Client

The official JavaScript/TypeScript client for Talisik URL Shortener - a privacy-focused URL shortening service.

Created by Erick Luna

🚀 Quick Start

Installation

# With npm
npm install talisik-shortener

# With yarn
yarn add talisik-shortener

# With pnpm
pnpm add talisik-shortener

Basic Usage

import { TalisikClient } from "talisik-shortener";

// Create a client instance
const client = new TalisikClient({
  baseUrl: "https://go.downlodr.com", // Your custom subdomain
});

// Shorten a URL
const result = await client.shorten({
  url: "https://example.com",
});

console.log(result.shortUrl); // https://go.downlodr.com/abc123

📖 Usage Examples

JavaScript (CommonJS)

const { TalisikClient } = require("talisik-shortener");

const client = new TalisikClient({
  baseUrl: "https://api.yourdomain.com",
});

async function shortenUrl() {
  try {
    const result = await client.shorten({
      url: "https://example.com",
      customCode: "my-link",
      expiresHours: 24,
    });

    console.log("Short URL:", result.shortUrl);
  } catch (error) {
    console.error("Error:", error.message);
  }
}

TypeScript

import {
  TalisikClient,
  ShortenRequest,
  ShortenResponse,
} from "talisik-shortener";

const client = new TalisikClient({
  baseUrl: "https://api.yourdomain.com",
  timeout: 10000,
});

async function shortenUrl(request: ShortenRequest): Promise<ShortenResponse> {
  return await client.shorten(request);
}

React with TypeScript

import React, { useState } from "react";
import { TalisikClient, ShortenResponse } from "talisik-shortener";

const client = new TalisikClient({
  baseUrl: "https://api.yourdomain.com",
});

function UrlShortener() {
  const [url, setUrl] = useState("");
  const [result, setResult] = useState<ShortenResponse | null>(null);
  const [loading, setLoading] = useState(false);

  const handleShorten = async () => {
    setLoading(true);
    try {
      const shortened = await client.shorten({ url });
      setResult(shortened);
    } catch (error) {
      console.error("Failed to shorten URL:", error);
    } finally {
      setLoading(false);
    }
  };

  return (
    <div>
      <input
        type="url"
        value={url}
        onChange={(e) => setUrl(e.target.value)}
        placeholder="Enter URL to shorten"
      />
      <button onClick={handleShorten} disabled={loading}>
        {loading ? "Shortening..." : "Shorten URL"}
      </button>

      {result && (
        <div>
          <p>
            Short URL: <a href={result.shortUrl}>{result.shortUrl}</a>
          </p>
          <p>Original: {result.originalUrl}</p>
        </div>
      )}
    </div>
  );
}

Vue 3 + TypeScript

<template>
  <div>
    <input v-model="url" placeholder="Enter URL to shorten" />
    <button @click="shortenUrl" :disabled="loading">
      {{ loading ? "Shortening..." : "Shorten URL" }}
    </button>

    <div v-if="result">
      <p>
        Short URL: <a :href="result.shortUrl">{{ result.shortUrl }}</a>
      </p>
    </div>
  </div>
</template>

<script setup lang="ts">
import { ref } from "vue";
import { TalisikClient, type ShortenResponse } from "talisik-shortener";

const client = new TalisikClient({
  baseUrl: "https://api.yourdomain.com",
});

const url = ref("");
const result = ref<ShortenResponse | null>(null);
const loading = ref(false);

async function shortenUrl() {
  loading.value = true;
  try {
    result.value = await client.shorten({ url: url.value });
  } catch (error) {
    console.error("Failed to shorten URL:", error);
  } finally {
    loading.value = false;
  }
}
</script>

### URL Management & Table Display ```typescript import { TalisikClient } from
"talisik-shortener"; const client = new TalisikClient({ baseUrl:
"https://api.yourdomain.com", }); // Get all URLs for admin dashboard or
analytics async function loadUrlTable() { try { const urls = await
client.getAllUrls(); console.log(`Total URLs: ${urls.length}`); // Display in
table format urls.forEach(url => { console.log(`${url.short_code} ->
${url.original_url} (${url.click_count} clicks)`); }); // Filter active URLs
const activeUrls = urls.filter(url => url.is_active); // Filter by expiration
const permanentUrls = urls.filter(url => !url.expires_at); return urls; } catch
(error) { console.error("Failed to load URLs:", error); return []; } } // React
component for URL management function UrlManagementTable() { const [urls,
setUrls] = useState([]); const [loading, setLoading] = useState(true);
useEffect(() => { loadUrlTable().then(data => { setUrls(data);
setLoading(false); }); }, []); if (loading) return
<div>Loading...</div>
; return (
<table>
      <thead>
        <tr>
          <th>Short Code</th>
          <th>Original URL</th>
          <th>Clicks</th>
          <th>Status</th>
          <th>Created</th>
        </tr>
      </thead>
      <tbody>
        {urls.map(url => (
          <tr key={url.short_code}>
            <td>{url.short_code}</td>
            <td>{url.original_url}</td>
            <td>{url.click_count}</td>
            <td>{url.is_active ? '✅ Active' : '❌ Inactive'}</td>
            <td>{new Date(url.created_at).toLocaleDateString()}</td>
          </tr>
        ))}
      </tbody>
    </table>
); }

Next.js API Route

// pages/api/shorten.ts
import { NextApiRequest, NextApiResponse } from "next";
import { TalisikClient } from "talisik-shortener";

const client = new TalisikClient({
  baseUrl: process.env.TALISIK_API_URL!,
});

export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  if (req.method !== "POST") {
    return res.status(405).json({ error: "Method not allowed" });
  }

  try {
    const { url } = req.body;
    const result = await client.shorten({ url });
    res.status(200).json(result);
  } catch (error) {
    res.status(500).json({ error: "Failed to shorten URL" });
  }
}

🎯 API Reference

TalisikClient

Constructor

new TalisikClient(config: TalisikConfig)

TalisikConfig

Property	Type	Required	Default	Description
`baseUrl`	`string`	✅	-	Base URL of your Talisik API server
`apiKey`	`string`	❌	-	API key for authentication
`timeout`	`number`	❌	`10000`	Request timeout in milliseconds
`headers`	`Record<string, string>`	❌	`{}`	Custom headers

Methods

`shorten(request, options?)`

Shorten a URL.

await client.shorten({
  url: "https://example.com",
  customCode: "my-link", // Optional
  expiresHours: 24, // Optional
});

Returns: Promise<ShortenResponse>

`getUrlInfo(shortCode, options?)`

Get information about a shortened URL.

const info = await client.getUrlInfo("abc123");

Returns: Promise<UrlInfo | null>

`getStats(options?)`

Get overall statistics.

const stats = await client.getStats();

Returns: Promise<Stats>

`getAllUrls(options?)`

Get all shortened URLs for table/list display. Returns an array of URL records with columns: original_url, short_code, expires_at, click_count, is_active, created_at.

const urls = await client.getAllUrls();
console.log(`Found ${urls.length} URLs`);

// Example response:
// [
//   {
//     "original_url": "https://example.com",
//     "short_code": "abc123",
//     "expires_at": null,
//     "click_count": 5,
//     "is_active": true,
//     "created_at": "2024-01-01T12:00:00Z"
//   }
// ]

Returns: Promise<Array<UrlRecord>>

`expand(shortCode, options?)`

Get the original URL for a short code.

const originalUrl = await client.expand("abc123");

Returns: Promise<string | null>

`getRedirectUrl(shortCode)`

Get the full redirect URL without making a request.

const redirectUrl = client.getRedirectUrl("abc123");
// Returns: https://api.yourdomain.com/abc123

Returns: string

🔧 Configuration

Custom Domain Setup

To use your own domain for the URL shortener:

⚠️ Important: If you already have a website at your root domain, use a subdomain to avoid breaking your existing site.

Option 1: Subdomain (Recommended for existing websites)

# DNS Configuration
Record Type: A
Name: go (creates go.yourdomain.com)
Value: your-platform-ip-address

# Results in URLs like: https://go.yourdomain.com/abc123

Option 2: Root Domain (Only if domain is unused)

# DNS Configuration
Record Type: A
Name: @ (uses root domain)
Value: your-platform-ip-address

# Results in URLs like: https://yourdomain.com/abc123

Platform Configuration: In your hosting platform (Leapcell, Vercel, etc.):

Add the custom domain/subdomain
Configure route rules to point to your service
Enable SSL certificate

Update your client:

const client = new TalisikClient({
  baseUrl: "https://go.yourdomain.com", // Your subdomain
});

Environment Variables

You can set default configuration using environment variables:

# .env
TALISIK_API_URL=https://api.yourdomain.com
TALISIK_API_KEY=your-api-key

Development vs Production

import { createDevClient, createProdClient } from "talisik-shortener";

// Development (uses localhost:8000)
const devClient = createDevClient();

// Production
const prodClient = createProdClient("https://api.yourdomain.com");

⚡ Advanced Usage

Error Handling

import { TalisikError } from "talisik-shortener";

try {
  const result = await client.shorten({ url: "invalid-url" });
} catch (error) {
  if (error instanceof TalisikError) {
    console.log("Status:", error.status);
    console.log("Code:", error.code);
    console.log("Is client error:", error.isClientError());
    console.log("Is not found:", error.isNotFound());
  }
}

Request Options

// Custom timeout and headers for a specific request
const result = await client.shorten(
  { url: "https://example.com" },
  {
    timeout: 5000,
    headers: { "Custom-Header": "value" },
  }
);

AbortController Support

const controller = new AbortController();

// Cancel the request after 3 seconds
setTimeout(() => controller.abort(), 3000);

try {
  const result = await client.shorten(
    { url: "https://example.com" },
    { signal: controller.signal }
  );
} catch (error) {
  if (error.name === "AbortError") {
    console.log("Request was cancelled");
  }
}

🏗️ Setup Your Own Server

This client works with the Talisik URL Shortener Python API. To set up your own server:

Clone the repository:

git clone https://github.com/frederickluna/talisik-short-url
cd talisik-short-url

Start the API server:

make install
make api
# Server running at http://localhost:8000

Use with your client:

const client = new TalisikClient({
  baseUrl: "http://localhost:8000",
});

For production deployment, see the deployment guide.

🔗 Related Packages

Python Library: Use directly in Python applications
CLI Tool: Command-line interface for URL shortening
Docker Images: Ready-to-deploy containers

📝 TypeScript Support

This package is written in TypeScript and includes comprehensive type definitions. No additional @types/ packages needed!

import type {
  TalisikConfig,
  ShortenRequest,
  ShortenResponse,
  UrlInfo,
  Stats,
  TalisikError,
} from "talisik-shortener";

👤 Author

Erick Luna

GitHub: @frederickluna
Project: Talisik Short URL

🤝 Contributing

Contributions are welcome! Please see our Contributing Guide.

📄 License

MIT License - see LICENSE file for details.

talisik-shortener

Talisik URL Shortener - JavaScript/TypeScript Client

🚀 Quick Start

Installation

Basic Usage

📖 Usage Examples

JavaScript (CommonJS)

TypeScript

React with TypeScript

Vue 3 + TypeScript

Next.js API Route

🎯 API Reference

TalisikClient

Constructor

TalisikConfig

Methods

shorten(request, options?)

getUrlInfo(shortCode, options?)

getStats(options?)

getAllUrls(options?)

expand(shortCode, options?)

getRedirectUrl(shortCode)

🔧 Configuration

Custom Domain Setup

Option 1: Subdomain (Recommended for existing websites)

Option 2: Root Domain (Only if domain is unused)

Environment Variables

Development vs Production

⚡ Advanced Usage

Error Handling

Request Options

AbortController Support

🏗️ Setup Your Own Server

🔗 Related Packages

📝 TypeScript Support

👤 Author

🤝 Contributing

📄 License

🔗 Links

Readme

Keywords

Package Sidebar

Install

Repository

Homepage

DownloadsWeekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators