@goatlab/typesense 0.0.2

package/dist/utils/tenant.js

@@ -0,0 +1,89 @@
+"use strict";
+/**
+ * Tenant utility functions for multitenancy support
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeTenantId = sanitizeTenantId;
+exports.createFQCN = createFQCN;
+exports.parseFQCN = parseFQCN;
+exports.isTenantCollection = isTenantCollection;
+exports.filterCollectionsByTenant = filterCollectionsByTenant;
+/**
+ * Validates and sanitizes a tenant ID for use in collection names
+ * - Enforces allowed characters: a-zA-Z0-9_-
+ * - Converts to lowercase to avoid case-sensitivity issues
+ * - Enforces max length of 128 characters
+ *
+ * @param tenantId - Raw tenant ID to validate
+ * @returns Sanitized tenant ID
+ * @throws Error if tenant ID is invalid
+ */
+function sanitizeTenantId(tenantId) {
+    if (!tenantId || typeof tenantId !== 'string') {
+        throw new Error('Tenant ID must be a non-empty string');
+    }
+    // Trim whitespace
+    const trimmed = tenantId.trim();
+    if (!trimmed) {
+        throw new Error('Tenant ID cannot be empty or whitespace only');
+    }
+    // Check allowed characters
+    const allowedPattern = /^[a-zA-Z0-9_\-]+$/;
+    if (!allowedPattern.test(trimmed)) {
+        throw new Error('Tenant ID can only contain alphanumeric characters, underscores, and hyphens');
+    }
+    // Check max length
+    if (trimmed.length > 128) {
+        throw new Error('Tenant ID cannot exceed 128 characters');
+    }
+    // Convert to lowercase
+    return trimmed.toLowerCase();
+}
+/**
+ * Creates a fully qualified collection name by prepending tenant ID
+ * Format: <tenantId>__<baseCollectionName>
+ *
+ * @param tenantId - Sanitized tenant ID
+ * @param baseCollectionName - Base collection name without tenant prefix
+ * @returns Fully qualified collection name
+ */
+function createFQCN(tenantId, baseCollectionName) {
+    return `${tenantId}__${baseCollectionName}`;
+}
+/**
+ * Extracts tenant ID and base collection name from a fully qualified collection name
+ *
+ * @param fqcn - Fully qualified collection name
+ * @returns Object with tenantId and baseCollectionName, or null if not a tenant collection
+ */
+function parseFQCN(fqcn) {
+    const separatorIndex = fqcn.indexOf('__');
+    if (separatorIndex === -1 || separatorIndex === 0) {
+        return null;
+    }
+    return {
+        tenantId: fqcn.substring(0, separatorIndex),
+        baseCollectionName: fqcn.substring(separatorIndex + 2)
+    };
+}
+/**
+ * Checks if a collection name is tenant-prefixed
+ *
+ * @param collectionName - Collection name to check
+ * @returns True if the collection has a tenant prefix
+ */
+function isTenantCollection(collectionName) {
+    return collectionName.includes('__') && !collectionName.startsWith('__');
+}
+/**
+ * Filters collections by tenant ID
+ *
+ * @param collections - Array of collection names
+ * @param tenantId - Tenant ID to filter by
+ * @returns Collections belonging to the specified tenant
+ */
+function filterCollectionsByTenant(collections, tenantId) {
+    const prefix = `${tenantId}__`;
+    return collections.filter(name => name.startsWith(prefix));
+}
+//# sourceMappingURL=tenant.js.map

package/dist/utils/tenant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant.js","sourceRoot":"","sources":["../../src/utils/tenant.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAYH,4CA2BC;AAUD,gCAEC;AAQD,8BAWC;AAQD,gDAEC;AASD,8DAGC;AA1FD;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAAC,QAAgB;IAC/C,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;IACzD,CAAC;IAED,kBAAkB;IAClB,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAA;IAE/B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;IACjE,CAAC;IAED,2BAA2B;IAC3B,MAAM,cAAc,GAAG,mBAAmB,CAAA;IAC1C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAA;IACH,CAAC;IAED,mBAAmB;IACnB,IAAI,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;IAC3D,CAAC;IAED,uBAAuB;IACvB,OAAO,OAAO,CAAC,WAAW,EAAE,CAAA;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAAC,QAAgB,EAAE,kBAA0B;IACrE,OAAO,GAAG,QAAQ,KAAK,kBAAkB,EAAE,CAAA;AAC7C,CAAC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,IAAY;IACpC,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzC,IAAI,cAAc,KAAK,CAAC,CAAC,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;QAClD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,cAAc,CAAC;QAC3C,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,GAAG,CAAC,CAAC;KACvD,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,cAAsB;IACvD,OAAO,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;AAC1E,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,yBAAyB,CAAC,WAAqB,EAAE,QAAgB;IAC/E,MAAM,MAAM,GAAG,GAAG,QAAQ,IAAI,CAAA;IAC9B,OAAO,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;AAC5D,CAAC"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "author": "ignacio.cabrera@goatlab.io",
+  "name": "@goatlab/typesense",
+  "version": "0.0.2",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@goatlab/js-utils": "0.8.42",
+    "@goatlab/tsconfig": "0.0.15"
+  },
+  "description": "Metabase API wrapper for TypeScript and Node.js",
+  "devDependencies": {
+    "@testcontainers/mysql": "^11.0.3",
+    "@types/node": "^18.15.9",
+    "@vitest/ui": "^3.2.4",
+    "dotenv-cli": "^7.1.0",
+    "eslint": "^8.36.0",
+    "happy-dom": "^18.0.1",
+    "prettier": "^2.8.7",
+    "pretty-quick": "^3.1.3",
+    "rimraf": "^5.0.1",
+    "testcontainers": "^11.3.1",
+    "ts-node": "^10.9.1",
+    "turbo": "^1.1.10",
+    "typescript": "^5.0.2",
+    "vitest": "^3.2.4"
+  },
+  "engines": {
+    "node": ">=14.16.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://docs.goatlab.io",
+  "keywords": [
+    "metabase",
+    "api",
+    "wrapper",
+    "typescript"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "lint": "eslint src --fix",
+    "prebuild": "rimraf dist",
+    "predev": "rimraf dist",
+    "prestart": "rimraf dist",
+    "serve": "tsc -w",
+    "test": "vitest run --reporter=verbose",
+    "test:ui": "vitest --ui",
+    "test:watch": "vitest",
+    "update:packages": "npm-check-updates -u && yarn"
+  }
+}