create-tina-app 1.6.2 → 2.1.0

package/dist/templates.d.ts

@@ -1,7 +1,12 @@
 import { Ora } from 'ora';
+type Feature = {
+    name: string;
+    description: string;
+};
 export type BaseExample = {
     title: string;
     description?: string;
+    features?: Feature[];
     value: string;
     devUrl: string;
 };
@@ -15,3 +20,4 @@ export type ExternalTemplate = BaseExample & {
 export type Template = InternalTemplate | ExternalTemplate;
 export declare const TEMPLATES: Template[];
 export declare function downloadTemplate(template: Template, root: string, spinner: Ora): Promise<void>;
+export {};

package/dist/util/asciiArt.d.ts

@@ -1,2 +1,3 @@
 export declare const llama: string;
+export declare const errorArt: string;
 export declare const tinaCms: string;

package/dist/util/fetchPosthogConfig.d.ts

@@ -0,0 +1,5 @@
+export interface PostHogConfig {
+    POSTHOG_API_KEY?: string;
+    POSTHOG_ENDPOINT?: string;
+}
+export default function fetchPostHogConfig(endpointUrl: string): Promise<PostHogConfig>;

package/dist/util/isNpm.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @typedef {Object} ValidationResult
+ * @property {string | null} message
+ * @property {boolean} isError
+ */
+/**
+ * Validates whether the provided name is valid on NPM.
+ *
+ * @param {string} name
+ * @returns {ValidationResult}
+ */
+export default function validate(name: string): ValidationResult;
+export type ValidationResult = {
+    message: string | null;
+    isError: boolean;
+};

package/dist/util/posthog.d.ts

@@ -0,0 +1,147 @@
+import { PostHog } from 'posthog-node';
+export declare const CreateTinaAppStartedEvent: string;
+export declare const CreateTinaAppFinishedEvent: string;
+/**
+ * Step names for tracking progress through the create-tina-app process
+ */
+export declare const TRACKING_STEPS: {
+    readonly INIT: "initializing";
+    readonly PRE_RUN_CHECKS: "pre_run_checks";
+    readonly TELEMETRY_SETUP: "telemetry_setup";
+    readonly PKG_MANAGER_SELECT: "package_manager_selection";
+    readonly PROJECT_NAME_INPUT: "project_name_input";
+    readonly TEMPLATE_SELECT: "template_selection";
+    readonly THEME_SELECT: "theme_selection";
+    readonly DIRECTORY_SETUP: "directory_setup";
+    readonly DOWNLOADING_TEMPLATE: "downloading_template";
+    readonly UPDATING_METADATA: "updating_metadata";
+    readonly INSTALLING_PACKAGES: "installing_packages";
+    readonly GIT_INIT: "git_initialization";
+    readonly COMPLETE: "complete";
+};
+/**
+ * Generate a unique session ID for this run
+ */
+export declare function generateSessionId(): string;
+/**
+ * Get a hashed user ID based on system UUID
+ * Returns a consistent anonymous identifier for the machine
+ */
+export declare function getAnonymousUserId(): Promise<string>;
+/**
+ * Structured error codes for categorizing failures
+ */
+export declare const ERROR_CODES: {
+    readonly ERR_VAL_INVALID_TEMPLATE: "ERR_VAL_INVALID_TEMPLATE";
+    readonly ERR_VAL_INVALID_PKG_MANAGER: "ERR_VAL_INVALID_PKG_MANAGER";
+    readonly ERR_VAL_INVALID_PROJECT_NAME: "ERR_VAL_INVALID_PROJECT_NAME";
+    readonly ERR_VAL_UNSUPPORTED_NODE: "ERR_VAL_UNSUPPORTED_NODE";
+    readonly ERR_VAL_NO_PKG_MANAGERS: "ERR_VAL_NO_PKG_MANAGERS";
+    readonly ERR_FS_NOT_WRITABLE: "ERR_FS_NOT_WRITABLE";
+    readonly ERR_FS_HAS_CONFLICTS: "ERR_FS_HAS_CONFLICTS";
+    readonly ERR_FS_MKDIR_FAILED: "ERR_FS_MKDIR_FAILED";
+    readonly ERR_FS_CHDIR_FAILED: "ERR_FS_CHDIR_FAILED";
+    readonly ERR_FS_READ_PACKAGE_JSON: "ERR_FS_READ_PACKAGE_JSON";
+    readonly ERR_FS_WRITE_PACKAGE_JSON: "ERR_FS_WRITE_PACKAGE_JSON";
+    readonly ERR_FS_UPDATE_THEME_FAILED: "ERR_FS_UPDATE_THEME_FAILED";
+    readonly ERR_FS_COPY_TEMPLATE_FAILED: "ERR_FS_COPY_TEMPLATE_FAILED";
+    readonly ERR_NET_POSTHOG_CONFIG_FETCH: "ERR_NET_POSTHOG_CONFIG_FETCH";
+    readonly ERR_NET_TARBALL_DOWNLOAD: "ERR_NET_TARBALL_DOWNLOAD";
+    readonly ERR_NET_GITHUB_API_FAILED: "ERR_NET_GITHUB_API_FAILED";
+    readonly ERR_NET_REPO_INFO_NOT_FOUND: "ERR_NET_REPO_INFO_NOT_FOUND";
+    readonly ERR_NET_REPO_INVALID_URL: "ERR_NET_REPO_INVALID_URL";
+    readonly ERR_NET_TARBALL_EXTRACT: "ERR_NET_TARBALL_EXTRACT";
+    readonly ERR_INSTALL_PKG_MANAGER_FAILED: "ERR_INSTALL_PKG_MANAGER_FAILED";
+    readonly ERR_INSTALL_PKG_MANAGER_NOT_FOUND: "ERR_INSTALL_PKG_MANAGER_NOT_FOUND";
+    readonly ERR_INSTALL_SPAWN_ERROR: "ERR_INSTALL_SPAWN_ERROR";
+    readonly ERR_INSTALL_TIMEOUT: "ERR_INSTALL_TIMEOUT";
+    readonly ERR_GIT_NOT_INSTALLED: "ERR_GIT_NOT_INSTALLED";
+    readonly ERR_GIT_INIT_FAILED: "ERR_GIT_INIT_FAILED";
+    readonly ERR_GIT_ADD_FAILED: "ERR_GIT_ADD_FAILED";
+    readonly ERR_GIT_COMMIT_FAILED: "ERR_GIT_COMMIT_FAILED";
+    readonly ERR_GIT_CHECKOUT_FAILED: "ERR_GIT_CHECKOUT_FAILED";
+    readonly ERR_GIT_ALREADY_INITIALIZED: "ERR_GIT_ALREADY_INITIALIZED";
+    readonly ERR_CANCEL_PKG_MANAGER_PROMPT: "ERR_CANCEL_PKG_MANAGER_PROMPT";
+    readonly ERR_CANCEL_PROJECT_NAME_PROMPT: "ERR_CANCEL_PROJECT_NAME_PROMPT";
+    readonly ERR_CANCEL_TEMPLATE_PROMPT: "ERR_CANCEL_TEMPLATE_PROMPT";
+    readonly ERR_CANCEL_THEME_PROMPT: "ERR_CANCEL_THEME_PROMPT";
+    readonly ERR_CANCEL_SIGINT: "ERR_CANCEL_SIGINT";
+    readonly ERR_CFG_POSTHOG_INIT_FAILED: "ERR_CFG_POSTHOG_INIT_FAILED";
+    readonly ERR_CFG_OSINFO_FETCH_FAILED: "ERR_CFG_OSINFO_FETCH_FAILED";
+    readonly ERR_CFG_TELEMETRY_SETUP_FAILED: "ERR_CFG_TELEMETRY_SETUP_FAILED";
+    readonly ERR_TPL_DOWNLOAD_FAILED: "ERR_TPL_DOWNLOAD_FAILED";
+    readonly ERR_TPL_EXTRACT_FAILED: "ERR_TPL_EXTRACT_FAILED";
+    readonly ERR_TPL_METADATA_UPDATE_FAILED: "ERR_TPL_METADATA_UPDATE_FAILED";
+    readonly ERR_TPL_INTERNAL_COPY_FAILED: "ERR_TPL_INTERNAL_COPY_FAILED";
+    readonly ERR_TPL_THEME_UPDATE_FAILED: "ERR_TPL_THEME_UPDATE_FAILED";
+    readonly ERR_UNCAUGHT: "ERR_UNCAUGHT";
+};
+/**
+ * Sends an event to PostHog for analytics tracking.
+ *
+ * @param client - The PostHog client instance used to send the event
+ * @param distinctId - A unique identifier for the user (hashed system UUID)
+ * @param sessionId - A unique identifier for this run/session
+ * @param event - The name of the event to track (e.g., 'create-tina-app-started')
+ * @param properties - Additional properties to include with the event
+ *
+ * @remarks
+ * - Returns early if the PostHog client is not provided
+ * - Skips sending data when `TINA_DEV` environment variable is set to 'true'
+ * - Automatically adds a 'system' property with value 'tinacms/create-tina-app'
+ * - Includes sessionId in properties to track individual runs
+ * - Uses hashed system UUID as distinctId to track unique users anonymously
+ * - Logs errors to console if event capture fails
+ *
+ * @example
+ * ```typescript
+ * const client = new PostHog('api-key');
+ * const userId = await getAnonymousUserId();
+ * const sessionId = generateSessionId();
+ * postHogCapture(client, userId, sessionId, 'create-tina-app-started', {
+ *   template: 'basic',
+ *   typescript: true
+ * });
+ * ```
+ */
+export declare function postHogCapture(client: PostHog, distinctId: string, sessionId: string, event: string, properties: Record<string, any>): void;
+/**
+ * Capture an error event in PostHog with categorized tracking and sanitized stack traces
+ *
+ * @param client - The PostHog client instance
+ * @param distinctId - A unique identifier for the user (hashed system UUID)
+ * @param sessionId - A unique identifier for this run/session
+ * @param error - The error object that was thrown
+ * @param context - Context about the error including code, category, step, and additional properties
+ *
+ * @remarks
+ * - Sanitizes stack traces to remove local file paths
+ * - Maps error categories to three event types:
+ *   - 'create-tina-app-error' for technical failures (filesystem, network, installation, git, etc.)
+ *   - 'create-tina-app-validation-error' for user input validation issues
+ *   - 'create-tina-app-user-cancelled' for user cancellations (Ctrl+C)
+ * - Includes error code, sanitized stack, step name, and telemetry data in properties
+ * - Non-fatal errors are tracked but allow the process to continue
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await downloadTemplate();
+ * } catch (err) {
+ *   postHogCaptureError(client, userId, sessionId, err as Error, {
+ *     errorCode: ERROR_CODES.ERR_TPL_DOWNLOAD_FAILED,
+ *     errorCategory: 'template',
+ *     step: TRACKING_STEPS.DOWNLOADING_TEMPLATE,
+ *     fatal: true,
+ *     additionalProperties: { template: 'basic' }
+ *   });
+ * }
+ * ```
+ */
+export declare function postHogCaptureError(client: PostHog | null, distinctId: string, sessionId: string, error: Error, context: {
+    errorCode: string;
+    errorCategory: string;
+    step: string;
+    fatal?: boolean;
+    additionalProperties?: Record<string, any>;
+}): void;

package/dist/util/textstyles.d.ts

@@ -1,11 +1,20 @@
-import chalk from 'chalk';
 export declare const TextStyles: {
-    tinaOrange: chalk.Chalk;
+    tinaOrange: import("chalk").ChalkInstance;
     link: (url: string) => string;
-    cmd: chalk.Chalk;
-    info: chalk.Chalk;
-    success: chalk.Chalk;
-    warn: chalk.Chalk;
-    err: chalk.Chalk;
-    bold: chalk.Chalk;
+    cmd: import("chalk").ChalkInstance;
+    info: import("chalk").ChalkInstance;
+    success: import("chalk").ChalkInstance;
+    warn: import("chalk").ChalkInstance;
+    err: import("chalk").ChalkInstance;
+    bold: import("chalk").ChalkInstance;
+};
+export declare const TextStylesBold: {
+    tinaOrange: import("chalk").ChalkInstance;
+    link: (url: string) => string;
+    cmd: import("chalk").ChalkInstance;
+    info: import("chalk").ChalkInstance;
+    success: import("chalk").ChalkInstance;
+    warn: import("chalk").ChalkInstance;
+    err: import("chalk").ChalkInstance;
+    bold: import("chalk").ChalkInstance;
 };

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "create-tina-app",
-  "version": "1.6.2",
+  "version": "2.1.0",
+  "type": "module",
   "main": "dist/index.js",
   "files": [
     "dist",
@@ -35,18 +36,18 @@
     "@types/prompts": "^2.4.9",
     "@types/tar": "6.1.13",
     "typescript": "^5.7.3",
-    "@tinacms/scripts": "1.4.1"
+    "@tinacms/scripts": "1.4.2"
   },
   "dependencies": {
-    "chalk": "4.1.2",
+    "chalk": "^5.4.1",
     "commander": "^12.1.0",
     "cross-spawn": "^7.0.6",
     "fs-extra": "^11.3.0",
     "ora": "^8.2.0",
+    "posthog-node": "^5.17.2",
     "prompts": "^2.4.2",
-    "tar": "7.4.0",
-    "validate-npm-package-name": "^5.0.1",
-    "@tinacms/metrics": "2.0.0"
+    "systeminformation": "^5.27.13",
+    "tar": "7.4.0"
   },
   "scripts": {
     "types": "pnpm tsc",