@tinyurl-ca/sdk 1.0.1

package/README.md

@@ -0,0 +1,208 @@
+# TinyURL.ca JavaScript/TypeScript SDK
+
+Official JavaScript/TypeScript SDK for the TinyURL.ca API.
+
+## Installation
+
+```bash
+npm install @tinyurl-ca/sdk
+```
+
+## Quick Start
+
+```typescript
+import { TinyURLClient } from '@tinyurl-ca/sdk';
+
+// Initialize client
+const client = new TinyURLClient({
+  apiKey: 'your_api_key_here'
+});
+
+// Shorten a URL
+const link = await client.createLink({
+  url: 'https://example.com'
+});
+
+console.log(link.shortUrl); // https://tinyurl.ca/abc123
+```
+
+## API Reference
+
+### Initialize Client
+
+```typescript
+import { TinyURLClient } from '@tinyurl-ca/sdk';
+
+const client = new TinyURLClient({
+  apiKey: 'your_api_key_here',
+  baseURL: 'https://tinyurl.ca/api/v1' // optional
+});
+```
+
+### Create a Link
+
+```typescript
+const link = await client.createLink({
+  url: 'https://example.com',
+  customCode: 'my-link',      // optional
+  title: 'My Website',         // optional
+  expiresIn: 86400            // optional, seconds
+});
+
+// Response
+{
+  id: 'abc123',
+  shortCode: 'my-link',
+  shortUrl: 'https://tinyurl.ca/my-link',
+  originalUrl: 'https://example.com',
+  title: 'My Website',
+  clicks: 0,
+  createdAt: '2026-04-04T00:00:00Z',
+  expiresAt: '2026-04-05T00:00:00Z'
+}
+```
+
+### Get Link Details
+
+```typescript
+const link = await client.getLink('link_id');
+```
+
+### List Links
+
+```typescript
+const links = await client.listLinks({
+  limit: 50,    // optional, default 50
+  offset: 0     // optional, default 0
+});
+```
+
+### Delete Link
+
+```typescript
+await client.deleteLink('link_id');
+```
+
+### Shorten URL (convenience method)
+
+```typescript
+const shortUrl = await client.shorten('https://example.com');
+// Returns: 'https://tinyurl.ca/abc123'
+
+// With custom code
+const customUrl = await client.shorten('https://example.com', 'promo');
+// Returns: 'https://tinyurl.ca/promo'
+```
+
+## TypeScript Support
+
+Full TypeScript support with type definitions included.
+
+```typescript
+import { TinyURLClient, Link, CreateLinkOptions } from '@tinyurl-ca/sdk';
+
+const options: CreateLinkOptions = {
+  url: 'https://example.com',
+  customCode: 'my-link'
+};
+
+const link: Link = await client.createLink(options);
+```
+
+## Error Handling
+
+```typescript
+try {
+  const link = await client.createLink({
+    url: 'https://example.com',
+    customCode: 'taken'
+  });
+} catch (error) {
+  if (error.response?.status === 409) {
+    console.log('Custom code already in use');
+  } else {
+    console.error('Error:', error.message);
+  }
+}
+```
+
+## Examples
+
+### Node.js
+
+```javascript
+const { TinyURLClient } = require('@tinyurl-ca/sdk');
+
+const client = new TinyURLClient({
+  apiKey: process.env.TINYURL_API_KEY
+});
+
+async function main() {
+  // Create link
+  const link = await client.createLink({
+    url: 'https://mywebsite.com',
+    title: 'My Website'
+  });
+  
+  console.log('Short URL:', link.shortUrl);
+  
+  // List all links
+  const links = await client.listLinks();
+  console.log('Total links:', links.length);
+}
+
+main();
+```
+
+### Next.js API Route
+
+```typescript
+import { TinyURLClient } from '@tinyurl-ca/sdk';
+import { NextRequest, NextResponse } from 'next/server';
+
+const client = new TinyURLClient({
+  apiKey: process.env.TINYURL_API_KEY!
+});
+
+export async function POST(request: NextRequest) {
+  const { url } = await request.json();
+  
+  const link = await client.createLink({ url });
+  
+  return NextResponse.json({ shortUrl: link.shortUrl });
+}
+```
+
+### Express.js
+
+```javascript
+const express = require('express');
+const { TinyURLClient } = require('@tinyurl-ca/sdk');
+
+const app = express();
+const client = new TinyURLClient({
+  apiKey: process.env.TINYURL_API_KEY
+});
+
+app.post('/shorten', async (req, res) => {
+  try {
+    const { url } = req.body;
+    const link = await client.createLink({ url });
+    res.json({ shortUrl: link.shortUrl });
+  } catch (error) {
+    res.status(500).json({ error: error.message });
+  }
+});
+
+app.listen(3000);
+```
+
+## License
+
+MIT
+
+## Support
+
+- Documentation: https://tinyurl.ca/docs
+- Issues: https://github.com/raj-iwt/tinyurl-sdk/issues
+- Email: support@tinyurl.ca

package/dist/index.d.mts

@@ -0,0 +1,70 @@
+interface TinyURLConfig {
+    apiKey: string;
+    baseURL?: string;
+}
+interface CreateLinkOptions {
+    url: string;
+    customCode?: string;
+    title?: string;
+    expiresIn?: number;
+}
+interface Link {
+    id: string;
+    shortCode: string;
+    shortUrl: string;
+    originalUrl: string;
+    title?: string;
+    clicks: number;
+    createdAt: string;
+    expiresAt?: string;
+}
+interface ListLinksOptions {
+    limit?: number;
+    offset?: number;
+}
+interface APIResponse<T> {
+    success: boolean;
+    data: T;
+    pagination?: {
+        limit: number;
+        offset: number;
+        total: number;
+    };
+}
+declare class TinyURLClient {
+    private api;
+    constructor(config: TinyURLConfig);
+    /**
+     * Create a new short link
+     * @param options - Link creation options
+     * @returns Created link details
+     */
+    createLink(options: CreateLinkOptions): Promise<Link>;
+    /**
+     * Get a specific link by ID
+     * @param id - Link ID
+     * @returns Link details
+     */
+    getLink(id: string): Promise<Link>;
+    /**
+     * List all links
+     * @param options - List options
+     * @returns Array of links
+     */
+    listLinks(options?: ListLinksOptions): Promise<Link[]>;
+    /**
+     * Delete a link
+     * @param id - Link ID to delete
+     */
+    deleteLink(id: string): Promise<void>;
+    /**
+     * Shorten a URL (convenience method)
+     * @param url - URL to shorten
+     * @param customCode - Optional custom short code
+     * @returns Short URL
+     */
+    shorten(url: string, customCode?: string): Promise<string>;
+}
+declare function createClient(config: TinyURLConfig): TinyURLClient;
+
+export { type APIResponse, type CreateLinkOptions, type Link, type ListLinksOptions, TinyURLClient, type TinyURLConfig, createClient, TinyURLClient as default };

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+interface TinyURLConfig {
+    apiKey: string;
+    baseURL?: string;
+}
+interface CreateLinkOptions {
+    url: string;
+    customCode?: string;
+    title?: string;
+    expiresIn?: number;
+}
+interface Link {
+    id: string;
+    shortCode: string;
+    shortUrl: string;
+    originalUrl: string;
+    title?: string;
+    clicks: number;
+    createdAt: string;
+    expiresAt?: string;
+}
+interface ListLinksOptions {
+    limit?: number;
+    offset?: number;
+}
+interface APIResponse<T> {
+    success: boolean;
+    data: T;
+    pagination?: {
+        limit: number;
+        offset: number;
+        total: number;
+    };
+}
+declare class TinyURLClient {
+    private api;
+    constructor(config: TinyURLConfig);
+    /**
+     * Create a new short link
+     * @param options - Link creation options
+     * @returns Created link details
+     */
+    createLink(options: CreateLinkOptions): Promise<Link>;
+    /**
+     * Get a specific link by ID
+     * @param id - Link ID
+     * @returns Link details
+     */
+    getLink(id: string): Promise<Link>;
+    /**
+     * List all links
+     * @param options - List options
+     * @returns Array of links
+     */
+    listLinks(options?: ListLinksOptions): Promise<Link[]>;
+    /**
+     * Delete a link
+     * @param id - Link ID to delete
+     */
+    deleteLink(id: string): Promise<void>;
+    /**
+     * Shorten a URL (convenience method)
+     * @param url - URL to shorten
+     * @param customCode - Optional custom short code
+     * @returns Short URL
+     */
+    shorten(url: string, customCode?: string): Promise<string>;
+}
+declare function createClient(config: TinyURLConfig): TinyURLClient;
+
+export { type APIResponse, type CreateLinkOptions, type Link, type ListLinksOptions, TinyURLClient, type TinyURLConfig, createClient, TinyURLClient as default };

package/dist/index.js

@@ -0,0 +1,104 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  TinyURLClient: () => TinyURLClient,
+  createClient: () => createClient,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_axios = __toESM(require("axios"));
+var TinyURLClient = class {
+  constructor(config) {
+    this.api = import_axios.default.create({
+      baseURL: config.baseURL || "https://tinyurl.ca/api/v1",
+      headers: {
+        "X-API-Key": config.apiKey,
+        "Content-Type": "application/json"
+      }
+    });
+  }
+  /**
+   * Create a new short link
+   * @param options - Link creation options
+   * @returns Created link details
+   */
+  async createLink(options) {
+    const response = await this.api.post("/links", options);
+    return response.data.data;
+  }
+  /**
+   * Get a specific link by ID
+   * @param id - Link ID
+   * @returns Link details
+   */
+  async getLink(id) {
+    const response = await this.api.get(`/links/${id}`);
+    return response.data.data;
+  }
+  /**
+   * List all links
+   * @param options - List options
+   * @returns Array of links
+   */
+  async listLinks(options) {
+    const response = await this.api.get("/links", {
+      params: options
+    });
+    return response.data.data;
+  }
+  /**
+   * Delete a link
+   * @param id - Link ID to delete
+   */
+  async deleteLink(id) {
+    await this.api.delete(`/links/${id}`);
+  }
+  /**
+   * Shorten a URL (convenience method)
+   * @param url - URL to shorten
+   * @param customCode - Optional custom short code
+   * @returns Short URL
+   */
+  async shorten(url, customCode) {
+    const link = await this.createLink({ url, customCode });
+    return link.shortUrl;
+  }
+};
+function createClient(config) {
+  return new TinyURLClient(config);
+}
+var index_default = TinyURLClient;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TinyURLClient,
+  createClient
+});

package/dist/index.mjs

@@ -0,0 +1,68 @@
+// src/index.ts
+import axios from "axios";
+var TinyURLClient = class {
+  constructor(config) {
+    this.api = axios.create({
+      baseURL: config.baseURL || "https://tinyurl.ca/api/v1",
+      headers: {
+        "X-API-Key": config.apiKey,
+        "Content-Type": "application/json"
+      }
+    });
+  }
+  /**
+   * Create a new short link
+   * @param options - Link creation options
+   * @returns Created link details
+   */
+  async createLink(options) {
+    const response = await this.api.post("/links", options);
+    return response.data.data;
+  }
+  /**
+   * Get a specific link by ID
+   * @param id - Link ID
+   * @returns Link details
+   */
+  async getLink(id) {
+    const response = await this.api.get(`/links/${id}`);
+    return response.data.data;
+  }
+  /**
+   * List all links
+   * @param options - List options
+   * @returns Array of links
+   */
+  async listLinks(options) {
+    const response = await this.api.get("/links", {
+      params: options
+    });
+    return response.data.data;
+  }
+  /**
+   * Delete a link
+   * @param id - Link ID to delete
+   */
+  async deleteLink(id) {
+    await this.api.delete(`/links/${id}`);
+  }
+  /**
+   * Shorten a URL (convenience method)
+   * @param url - URL to shorten
+   * @param customCode - Optional custom short code
+   * @returns Short URL
+   */
+  async shorten(url, customCode) {
+    const link = await this.createLink({ url, customCode });
+    return link.shortUrl;
+  }
+};
+function createClient(config) {
+  return new TinyURLClient(config);
+}
+var index_default = TinyURLClient;
+export {
+  TinyURLClient,
+  createClient,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@tinyurl-ca/sdk",
+  "version": "1.0.1",
+  "description": "Official JavaScript/TypeScript SDK for TinyURL.ca API",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "test": "jest",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "url-shortener",
+    "tinyurl",
+    "sdk",
+    "api-client",
+    "typescript"
+  ],
+  "author": "TinyURL.ca",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "jest": "^29.7.0",
+    "@types/jest": "^29.5.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/raj-iwt/linksnap.git",
+    "directory": "sdk"
+  },
+  "homepage": "https://tinyurl.ca/docs"
+}