@unchainedshop/cockpit-api 1.0.33 → 2.1.0

package/dist/utils/index.js

@@ -0,0 +1,5 @@
+/**
+ * Utility exports
+ */
+export { getTenantIds, resolveApiKey } from "./tenant.js";
+export { generateCmsRouteReplacements, generateCollectionAndSingletonSlugRouteMap, } from "./route-map.js";

package/dist/utils/route-map.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Route map utilities for CMS page link resolution
+ */
+import type { CacheManager } from "../core/cache.ts";
+/**
+ * Generate route replacements for page links (pages://id -> actual route)
+ */
+export declare function generateCmsRouteReplacements(endpoint: string, tenant?: string, cache?: CacheManager): Promise<Record<string, string>>;
+/**
+ * Generate slug to route map for collections and singletons
+ */
+export declare function generateCollectionAndSingletonSlugRouteMap(endpoint: string, tenant?: string, cache?: CacheManager): Promise<Record<string, string>>;

package/dist/utils/route-map.js

@@ -0,0 +1,86 @@
+/**
+ * Route map utilities for CMS page link resolution
+ */
+import { logger } from "../cockpit-logger.js";
+/**
+ * Generate route replacements for page links (pages://id -> actual route)
+ */
+export async function generateCmsRouteReplacements(endpoint, tenant, cache) {
+    const cacheKey = `ROUTE_REPLACEMENT_MAP:${tenant ?? "default"}`;
+    if (cache) {
+        const cached = cache.get(cacheKey);
+        if (cached)
+            return cached;
+    }
+    const filterParams = {
+        fields: JSON.stringify({ _id: 1, slug: 1, _r: 1 }),
+    };
+    try {
+        const origin = new URL(endpoint).origin;
+        const apiPath = tenant !== undefined ? `/:${tenant}/api` : "/api";
+        const response = await fetch(`${origin}${apiPath}/pages/pages?${new URLSearchParams(filterParams).toString()}`);
+        if (!response.ok) {
+            logger.warn(`Cockpit: Failed to fetch route replacements (status ${String(response.status)})`);
+            return {};
+        }
+        const pagesResponse = await response.json();
+        const pagesArr = (Array.isArray(pagesResponse) ? pagesResponse : []);
+        const replacement = pagesArr.reduce((result, item) => {
+            const key = `pages://${item._id}`;
+            const value = item._r;
+            return { ...result, [key]: value };
+        }, {});
+        if (cache) {
+            cache.set(cacheKey, replacement);
+        }
+        return replacement;
+    }
+    catch (e) {
+        logger.warn("Cockpit: Failed to fetch route replacements", e);
+        return {};
+    }
+}
+/**
+ * Generate slug to route map for collections and singletons
+ */
+export async function generateCollectionAndSingletonSlugRouteMap(endpoint, tenant, cache) {
+    const cacheKey = `SLUG_ROUTE_MAP:${tenant ?? "default"}`;
+    if (cache) {
+        const cached = cache.get(cacheKey);
+        if (cached)
+            return cached;
+    }
+    const filterParams = {
+        fields: JSON.stringify({
+            data: { collection: 1, singleton: 1 },
+            _r: 1,
+            type: 1,
+        }),
+        filter: JSON.stringify({ "data.collection": { $ne: null } }),
+    };
+    try {
+        const origin = new URL(endpoint).origin;
+        const apiPath = tenant !== undefined ? `/:${tenant}/api` : "/api";
+        const response = await fetch(`${origin}${apiPath}/pages/pages?locale=default&${new URLSearchParams(filterParams).toString()}`);
+        if (!response.ok) {
+            logger.warn(`Cockpit: Failed to fetch slug route map (status ${String(response.status)})`);
+            return {};
+        }
+        const pagesResponse = await response.json();
+        const pagesArr = (Array.isArray(pagesResponse) ? pagesResponse : []);
+        const pageMap = pagesArr.reduce((result, { data, _r }) => {
+            const entityName = data?.collection ?? data?.singleton;
+            if (entityName === undefined)
+                return result;
+            return { ...result, [entityName]: _r };
+        }, {});
+        if (cache) {
+            cache.set(cacheKey, pageMap);
+        }
+        return pageMap;
+    }
+    catch (e) {
+        logger.warn("Cockpit: Failed to fetch slug route map", e);
+        return {};
+    }
+}

package/dist/utils/tenant.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Tenant utilities for multi-tenant Cockpit CMS support
+ */
+import type { CockpitAPIOptions } from "../core/config.ts";
+/**
+ * Options for URL-based tenant resolution
+ */
+export interface ResolveTenantFromUrlOptions {
+    /** Default hostname to exclude from tenant matching (e.g., "gastro") */
+    defaultHost?: string;
+}
+/**
+ * Result of tenant resolution from URL
+ */
+export interface TenantUrlResult {
+    /** Resolved tenant ID or null if not found */
+    tenant: string | null;
+    /** Slug extracted from pathname (last path segment) */
+    slug: string | null;
+    /** The parsed hostname */
+    hostname: string;
+}
+/**
+ * Options for subdomain-based tenant resolution
+ */
+export interface ResolveTenantFromSubdomainOptions {
+    /** Default hostname to exclude from tenant matching */
+    defaultHost?: string;
+}
+/**
+ * Get all configured tenant IDs from environment variables
+ * Looks for COCKPIT_SECRET_<TENANT> patterns
+ */
+export declare const getTenantIds: () => string[];
+/**
+ * Resolve the API key for a tenant
+ * Priority: options.apiKey > COCKPIT_SECRET_<TENANT> > COCKPIT_SECRET
+ */
+export declare const resolveApiKey: (tenant?: string, options?: CockpitAPIOptions) => string | undefined;
+/**
+ * Resolve tenant ID from a subdomain
+ *
+ * Checks if the subdomain matches any configured tenant ID (from COCKPIT_SECRET_* env vars).
+ * Returns null if subdomain matches defaultHost or is not a valid tenant.
+ *
+ * @example
+ * ```typescript
+ * // With COCKPIT_SECRET_MYTENANT env var set:
+ * resolveTenantFromSubdomain("mytenant") // Returns: "mytenant"
+ * resolveTenantFromSubdomain("unknown")  // Returns: null
+ * resolveTenantFromSubdomain("gastro", { defaultHost: "gastro" }) // Returns: null
+ * ```
+ */
+export declare function resolveTenantFromSubdomain(subdomain: string | undefined, options?: ResolveTenantFromSubdomainOptions): string | null;
+/**
+ * Resolve tenant ID and slug from a URL
+ *
+ * Examines the subdomain of the URL against configured tenant IDs.
+ * Returns null for tenant if subdomain matches defaultHost or is not a valid tenant.
+ *
+ * @example
+ * ```typescript
+ * // With COCKPIT_SECRET_MYTENANT env var set:
+ * resolveTenantFromUrl("https://mytenant.example.com/some/page")
+ * // Returns: { tenant: "mytenant", slug: "page", hostname: "mytenant.example.com" }
+ *
+ * resolveTenantFromUrl("https://gastro.example.com/page", { defaultHost: "gastro" })
+ * // Returns: { tenant: null, slug: "page", hostname: "gastro.example.com" }
+ * ```
+ */
+export declare function resolveTenantFromUrl(url: string, options?: ResolveTenantFromUrlOptions): TenantUrlResult;

package/dist/utils/tenant.js

@@ -0,0 +1,88 @@
+/**
+ * Tenant utilities for multi-tenant Cockpit CMS support
+ */
+/**
+ * Get all configured tenant IDs from environment variables
+ * Looks for COCKPIT_SECRET_<TENANT> patterns
+ */
+export const getTenantIds = () => {
+    const env = { ...process.env };
+    const cockpitSecretKeys = Object.keys(env).filter((key) => key.includes("COCKPIT_SECRET") &&
+        key !== "COCKPIT_SECRET" &&
+        !key.endsWith("_FILE"));
+    return cockpitSecretKeys.map((key) => {
+        return key.slice("COCKPIT_SECRET_".length).toLowerCase();
+    });
+};
+/**
+ * Resolve the API key for a tenant
+ * Priority: options.apiKey > COCKPIT_SECRET_<TENANT> > COCKPIT_SECRET
+ */
+export const resolveApiKey = (tenant, options) => {
+    if (options?.apiKey !== undefined)
+        return options.apiKey;
+    const secretName = ["COCKPIT_SECRET", tenant]
+        .filter(Boolean)
+        .join("_")
+        .toUpperCase();
+    return process.env[secretName];
+};
+/**
+ * Resolve tenant ID from a subdomain
+ *
+ * Checks if the subdomain matches any configured tenant ID (from COCKPIT_SECRET_* env vars).
+ * Returns null if subdomain matches defaultHost or is not a valid tenant.
+ *
+ * @example
+ * ```typescript
+ * // With COCKPIT_SECRET_MYTENANT env var set:
+ * resolveTenantFromSubdomain("mytenant") // Returns: "mytenant"
+ * resolveTenantFromSubdomain("unknown")  // Returns: null
+ * resolveTenantFromSubdomain("gastro", { defaultHost: "gastro" }) // Returns: null
+ * ```
+ */
+export function resolveTenantFromSubdomain(subdomain, options = {}) {
+    if (subdomain === undefined)
+        return null;
+    const { defaultHost } = options;
+    const normalizedSubdomain = subdomain.toLowerCase();
+    // Skip if it matches the default host
+    if (normalizedSubdomain === defaultHost?.toLowerCase()) {
+        return null;
+    }
+    // Check against configured tenant IDs
+    const tenantIds = getTenantIds();
+    const matchedTenant = tenantIds.find((id) => id === normalizedSubdomain);
+    return matchedTenant ?? null;
+}
+/**
+ * Resolve tenant ID and slug from a URL
+ *
+ * Examines the subdomain of the URL against configured tenant IDs.
+ * Returns null for tenant if subdomain matches defaultHost or is not a valid tenant.
+ *
+ * @example
+ * ```typescript
+ * // With COCKPIT_SECRET_MYTENANT env var set:
+ * resolveTenantFromUrl("https://mytenant.example.com/some/page")
+ * // Returns: { tenant: "mytenant", slug: "page", hostname: "mytenant.example.com" }
+ *
+ * resolveTenantFromUrl("https://gastro.example.com/page", { defaultHost: "gastro" })
+ * // Returns: { tenant: null, slug: "page", hostname: "gastro.example.com" }
+ * ```
+ */
+export function resolveTenantFromUrl(url, options = {}) {
+    const parsedUrl = new URL(url);
+    const hostname = parsedUrl.hostname;
+    // Extract slug from pathname (last segment)
+    const pathSegments = parsedUrl.pathname.split("/").filter(Boolean);
+    const lastSegment = pathSegments[pathSegments.length - 1];
+    const slug = lastSegment ?? null;
+    // Extract subdomain (first part of hostname)
+    const hostnameParts = hostname.split(".");
+    const firstPart = hostnameParts[0];
+    const subdomain = firstPart?.toLowerCase();
+    // Resolve tenant from subdomain
+    const tenant = resolveTenantFromSubdomain(subdomain, options);
+    return { tenant, slug, hostname };
+}

package/package.json

@@ -1,15 +1,33 @@
 {
   "name": "@unchainedshop/cockpit-api",
-  "version": "1.0.33",
+  "version": "2.1.0",
   "description": "A package to interact with the Cockpit CMS API, including functionalities to handle GraphQL requests and various CMS content manipulations.",
   "main": "dist/index.js",
   "homepage": "https://unchained.shop",
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./schema": {
+      "types": "./dist/schema/index.d.ts",
+      "import": "./dist/schema/index.js"
+    },
+    "./fetch": {
+      "types": "./dist/fetch/index.d.ts",
+      "import": "./dist/fetch/index.js"
+    }
+  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "test": "node --experimental-transform-types --test --experimental-test-coverage --test-coverage-exclude='src/index.ts' --test-coverage-exclude='src/**/*.test.ts' --test-coverage-exclude='src/__tests__/*' src/*.test.ts src/**/*.test.ts",
+    "test:watch": "node --experimental-transform-types --test --watch src/*.test.ts src/**/*.test.ts"
   },
   "repository": {
     "type": "git",
@@ -24,15 +42,39 @@
     "api"
   ],
   "author": "Mikael Araya",
-  "license": "ISC",
+  "contributors": [
+    "Pascal Kaufmann"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=20"
+  },
   "dependencies": {
-    "@unchainedshop/logger": "^2.11.2",
-    "graphql": "^16.9.0",
-    "lru-cache": "^10.3.0"
+    "@unchainedshop/logger": "^4.6.0",
+    "lru-cache": "^11.2.4"
   },
   "types": "dist/index.d.ts",
+  "peerDependencies": {
+    "@graphql-tools/wrap": "11.1.4",
+    "graphql": "^15.0.0 || ^16.0.0"
+  },
+  "peerDependenciesMeta": {
+    "graphql": {
+      "optional": true
+    },
+    "@graphql-tools/wrap": {
+      "optional": true
+    }
+  },
   "devDependencies": {
-    "@types/node": "^20.14.9",
-    "typescript": "^5.5.2"
+    "@eslint/js": "^9.39.2",
+    "@types/node": "^24.10.7",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "graphql": "^16.12.0",
+    "prettier": "^3.7.4",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.52.0"
   }
 }

package/.github/workflows/npm-publish.yml

@@ -1,33 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - run: npm ci
-      - run: npm test
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.nvmrc

@@ -1 +0,0 @@
-20

package/dist/api.d.ts

@@ -1,70 +0,0 @@
-interface CockpitAPIOptions {
-    endpoint?: string;
-    apiKey?: string;
-}
-export declare enum ImageSizeMode {
-    Thumbnail = "thumbnail",
-    BestFit = "bestFit",
-    Resize = "resize",
-    FitToWidth = "fitToWidth",
-    FitToHeight = "fitToHeight"
-}
-export declare enum MimeType {
-    AUTO = "auto",
-    GIF = "gif",
-    JPEG = "jpeg",
-    PNG = "png",
-    WEBP = "webp",
-    BMP = "bmp"
-}
-export declare const getTenantIds: () => string[];
-export declare const generateCmsRouteReplacements: (tenant?: string) => Promise<any>;
-export declare const generateCollectionAndSingletonSlugRouteMap: (tenant?: string) => Promise<any>;
-export declare const FixImagePaths: (replacements: any, tenant?: string) => {
-    transformResult(originalResponse: any): any;
-};
-export declare const CockpitAPI: (tenant?: string, cockpitOptions?: CockpitAPIOptions) => Promise<{
-    graphQL(document: any, variables: any): Promise<any>;
-    getContentItem({ model, id }: {
-        model: string;
-        id?: string;
-    }, locale?: string, queryParams?: {}, { useAdminAccess }?: {
-        useAdminAccess?: boolean;
-    }): Promise<any>;
-    getAggregateModel({ model, pipeline }: {
-        model: string;
-        pipeline: any[];
-    }, locale?: string): Promise<any>;
-    getContentItems(model: string, locale?: string, queryParams?: any): Promise<any>;
-    getContentTree(model: string, locale?: string, queryParams?: {
-        filter: {};
-    }): Promise<any>;
-    postContentItem(model: string, item: any): Promise<any>;
-    deleteContentItem(model: string, id?: string): Promise<any>;
-    pages(locale?: string, queryParams?: {}): Promise<any>;
-    pageById({ page, id }: {
-        page: string;
-        id: string;
-    }, locale?: string, queryParams?: {}): Promise<any>;
-    pageByRoute(route: string, locale?: string): Promise<any>;
-    pagesMenus(locale?: string): Promise<any>;
-    pagesMenu(name: string, locale?: string): Promise<any>;
-    pagesRoutes(locale?: string): Promise<any>;
-    pagesSitemap(): Promise<any>;
-    pagesSetting(locale?: string): Promise<any>;
-    healthCheck(): Promise<any>;
-    lokalize(projectName: string, locale?: string, nested?: any): Promise<any>;
-    assetById(assetId: string): Promise<any>;
-    imageAssetById(assetId: string, queryParams?: {
-        m?: ImageSizeMode;
-        w?: number;
-        h?: number;
-        q?: number;
-        mime?: MimeType;
-        re?: number;
-        t?: string;
-        o?: number;
-    }): Promise<any>;
-    getFullRouteForSlug(slug: string): Promise<any>;
-}>;
-export {};