@youcan/cli 1.0.0 → 1.0.1

package/dist/core/client/client.js

@@ -0,0 +1,65 @@
+import { FormData } from 'formdata-node';
+import { mergeDeepLeft } from 'ramda';
+import fetch from 'node-fetch';
+import { post, get } from '../../utils/http.js';
+import config from '../../config/index.js';
+import { delay } from '../../utils/common.js';
+
+class Client {
+    constructor() {
+        this.accessToken = null;
+    }
+    setAccessToken(token) {
+        this.accessToken = token;
+    }
+    getAccessToken() {
+        return this.accessToken;
+    }
+    isAuthenticated() {
+        return this.accessToken != null;
+    }
+    async initTheme(data) {
+        const form = new FormData();
+        Object.entries(data).forEach(([key, value]) => form.append(key, value));
+        const { id } = await post(`${config.SELLER_AREA_API_BASE_URI}/themes/init`, this.withDefaults({ body: form }));
+        return id;
+    }
+    async getThemeMeta(themeId) {
+        return await get(`${config.SELLER_AREA_API_BASE_URI}/themes/${themeId}/metadata`, this.withDefaults({}));
+    }
+    async pullTheme(themeId) {
+        return await fetch(`${config.SELLER_AREA_API_BASE_URI}/themes/${themeId}`, this.withDefaults({}));
+    }
+    async listThemes() {
+        return await get(`${config.SELLER_AREA_API_BASE_URI}/themes`, this.withDefaults({}));
+    }
+    async deleteTheme(themeId) {
+        return await post(`${config.SELLER_AREA_API_BASE_URI}/themes/${themeId}/delete`, this.withDefaults({}));
+    }
+    async updateFile(themeId, data) {
+        const form = new FormData();
+        Object.entries(data).forEach(([key, value]) => form.append(key, value));
+        await post(`${config.SELLER_AREA_API_BASE_URI}/themes/${themeId}/update`, this.withDefaults({ body: form }));
+        await delay(100);
+    }
+    async deleteFile(themeId, data) {
+        const form = new FormData();
+        Object.entries(data).forEach(([key, value]) => form.append(key, value));
+        await post(`${config.SELLER_AREA_API_BASE_URI}/themes/${themeId}/update`, this.withDefaults({ body: form }));
+        await delay(100);
+    }
+    async getStoreInfo() {
+        return await get(`${config.SELLER_AREA_API_BASE_URI}/me`, this.withDefaults());
+    }
+    withDefaults(override = {}) {
+        return mergeDeepLeft(override, {
+            headers: {
+                Accept: 'application/json',
+                Authorization: `Bearer ${this.accessToken}`,
+            },
+            hostname: config.SELLER_AREA_API_BASE_URI,
+        });
+    }
+}
+
+export { Client as default };

package/dist/core/themes/preview.js

@@ -0,0 +1,33 @@
+import { createServer } from 'http';
+import { Server } from 'socket.io';
+import puppeteer from 'puppeteer';
+import stdout from '../../utils/system/stdout.js';
+import config from '../../config/index.js';
+
+async function openPreviewPage(url) {
+    const browser = await puppeteer.launch({
+        headless: false,
+        defaultViewport: null,
+        userDataDir: '/tmp/youcan_puppeteer',
+    });
+    browser.on('disconnected', () => {
+        stdout.info('Browser closed');
+        return process.exit(0);
+    });
+    const page = await browser.newPage();
+    await page.goto(url);
+    return page;
+}
+async function previewTheme(url) {
+    const httpServer = createServer();
+    const io = new Server(httpServer);
+    const previewPage = await openPreviewPage(url);
+    io.on('connection', (socket) => {
+        socket.on('theme:update', async () => {
+            await previewPage.reload({ waitUntil: 'domcontentloaded' });
+        });
+    });
+    httpServer.listen(config.PREVIEW_SERVER_PORT);
+}
+
+export { previewTheme as default };

package/dist/index.js

@@ -0,0 +1,3 @@
+import cli from './cli/index.js';
+
+cli.init();

package/dist/lib/cli/commands/auth/login.d.ts

@@ -0,0 +1,2 @@
+import type { CLI, CommandDefinition } from '@/cli/commands/types';
+export default function command(_cli: CLI): CommandDefinition;

package/dist/lib/cli/commands/auth/logout.d.ts

@@ -0,0 +1,2 @@
+import type { CLI, CommandDefinition } from '@/cli/commands/types';
+export default function command(cli: CLI): CommandDefinition;

package/dist/lib/cli/commands/auth/types.d.ts

@@ -0,0 +1,6 @@
+export interface TokenResponse {
+    token_type: string;
+    expires_in: string;
+    access_token: string;
+    refresh_toekn: string;
+}

package/dist/lib/cli/commands/index.d.ts

@@ -0,0 +1,6 @@
+export { default as LoginCommand } from './auth/login';
+export { default as LogoutCommand } from './auth/logout';
+export { default as InitCommand } from './theme/init';
+export { default as DevCommand } from './theme/dev';
+export { default as DeleteCommand } from './theme/delete';
+export { default as PullCommand } from './theme/pull';

package/dist/lib/cli/commands/theme/delete.d.ts

@@ -0,0 +1,2 @@
+import type { CLI, CommandDefinition } from '@/cli/commands/types';
+export default function command(cli: CLI): CommandDefinition;

package/dist/lib/cli/commands/theme/dev.d.ts

@@ -0,0 +1,2 @@
+import type { CLI, CommandDefinition } from '../types';
+export default function command(cli: CLI): CommandDefinition;

package/dist/lib/cli/commands/theme/init.d.ts

@@ -0,0 +1,2 @@
+import type { CLI, CommandDefinition } from '@/cli/commands/types';
+export default function command(cli: CLI): CommandDefinition;

package/dist/lib/cli/commands/theme/pull.d.ts

@@ -0,0 +1,2 @@
+import type { CLI, CommandDefinition } from '../types';
+export default function command(cli: CLI): CommandDefinition;

package/dist/lib/cli/commands/theme/types.d.ts

@@ -0,0 +1,17 @@
+export interface FileEventOptions {
+    path: string;
+    size: number;
+    roundtrip: number;
+    event: string;
+}
+export interface ThemeMetaData {
+    id: string;
+    name: string;
+    size: number;
+    version: string;
+    live: boolean;
+}
+export interface listThemesResponse {
+    dev: ThemeMetaData[];
+    published: ThemeMetaData[];
+}

package/dist/lib/cli/commands/types.d.ts

@@ -0,0 +1,22 @@
+import type { CAC } from 'cac';
+import type Client from '@/core/client/client';
+export interface CommandOptionDefinition {
+    name: string;
+    description: string;
+    config?: {
+        default?: any;
+        type?: any[];
+    };
+}
+export interface CommandDefinition {
+    name: string;
+    group: string;
+    aliases?: string[];
+    description: string;
+    action: ReturnType<any>;
+    options?: CommandOptionDefinition[];
+}
+export interface CLI {
+    handler: CAC;
+    client: Client;
+}

package/dist/lib/cli/index.d.ts

@@ -0,0 +1,12 @@
+import * as commands from './commands';
+import type { CommandDefinition } from './commands/types';
+import Client from '@/core/client/client';
+declare const cli: {
+    client: Client;
+    handler: import("cac").CAC;
+    registerCommand(command: (cli: typeof this) => CommandDefinition): void;
+    getAvailableCommands(): (typeof commands.LoginCommand | typeof commands.LogoutCommand | typeof commands.InitCommand | typeof commands.DevCommand | typeof commands.DeleteCommand | typeof commands.PullCommand)[];
+    init(): Promise<void>;
+    prepareClient(): Promise<void>;
+};
+export default cli;

package/dist/lib/config/index.d.ts

@@ -0,0 +1,21 @@
+declare const _default: {
+    OAUTH_CLIENT_ID: number;
+    OAUTH_CALLBACK_PORT: number;
+    OAUTH_CALLBACK_SERVER_TIMEOUT: number;
+    OAUTH_CALLBACK_URL: string;
+    OAUTH_CLIENT_SECRET: string;
+    OAUTH_AUTH_CODE_URL: string;
+    OAUTH_ACCESS_TOKEN_URL: string;
+    SELLER_AREA_API_BASE_URI: string;
+    SELLER_AREA_WEB_BASE_URI: string;
+    STARTER_THEME_GIT_REPOSITORY: string;
+    AVAILABLE_THEMES: {
+        name: string;
+        repository: string;
+    }[];
+    CLI_GLOBAL_CONFIG_DIR: string;
+    CLI_GLOBAL_CONFIG_PATH: string;
+    THEME_FILE_TYPES: string[];
+    PREVIEW_SERVER_PORT: number;
+};
+export default _default;

package/dist/lib/config/messages.d.ts

@@ -0,0 +1,25 @@
+declare const _default: {
+    LOGIN_OPEN_LINK: string;
+    LOGIN_SUCCESS: string;
+    INIT_SUCCESS: string;
+    INIT_CLONE_START: string;
+    AUTH_USER_NOT_LOGGED_IN: string;
+    AUTH_USER_LOGGED_OUT: string;
+    DELETE_NO_THEME_SELECTED: string;
+    DELETE_THEME_DELETED: string;
+    DELETE_NO_REMOTE_THEMES: string;
+    DELETE_SELECT_THEME: string;
+    DELETE_IN_PROGRESS: string;
+    DELETE_ERROR: string;
+    DEV_PREVIEW_SERVER_CONNECTED: string;
+    DEV_WATCHING_FILES: string;
+    DEV_NO_THEME_DETECTED: string;
+    PULL_NO_THEME_FOUND: string;
+    PULL_PULLING_THEME: string;
+    PULL_UNPACKING_THEME: string;
+    PULL_THEME_PULLED: string;
+    PREVIEW_BROWSER_CLOSED: string;
+    PREVIEW_THEME_UPDATED: string;
+    PREVIEW_RELOADED: string;
+};
+export default _default;

package/dist/lib/core/client/client.d.ts

@@ -0,0 +1,17 @@
+import type { DeleteThemeFileRequestData, InitThemeRequest as InitThemeRequestData, StoreInfoResponse, ThemeMetaResponse, UpdateThemeFileRequestData } from './types';
+export default class Client {
+    private accessToken;
+    constructor();
+    setAccessToken(token: string): void;
+    getAccessToken(): string | null;
+    isAuthenticated(): boolean;
+    initTheme(data: InitThemeRequestData): Promise<string>;
+    getThemeMeta(themeId: string): Promise<ThemeMetaResponse>;
+    pullTheme(themeId: string): Promise<import("node-fetch").Response>;
+    listThemes(): Promise<unknown>;
+    deleteTheme(themeId: string): Promise<unknown>;
+    updateFile(themeId: string, data: UpdateThemeFileRequestData): Promise<void>;
+    deleteFile(themeId: string, data: DeleteThemeFileRequestData): Promise<void>;
+    getStoreInfo(): Promise<StoreInfoResponse>;
+    private withDefaults;
+}

package/dist/lib/core/client/types.d.ts

@@ -0,0 +1,52 @@
+import type { File } from 'formdata-node';
+export interface InitThemeRequest {
+    archive: File;
+    theme_name: string;
+    theme_author: string;
+    theme_version: string;
+    theme_support_url: string;
+    theme_documentation_url: string;
+}
+export interface UpdateThemeFileRequestData {
+    file_type: string;
+    file_name: string;
+    file_content: File;
+    file_operation: 'save';
+}
+export interface DeleteThemeFileRequestData {
+    file_type: string;
+    file_name: string;
+    file_operation: 'delete';
+}
+export interface InitThemeResponse {
+    id: string;
+}
+export interface StoreInfoResponse {
+    name: string;
+    slug: string;
+    domain: string;
+}
+export interface ThemeFileInfo {
+    id: string;
+    type: string;
+    name: string;
+    file_name: string;
+    updated: boolean;
+    deleted: boolean;
+    size: number;
+    hash: string;
+}
+export interface ThemeMetaResponse {
+    theme_name: string;
+    theme_author: string;
+    theme_version: string;
+    theme_support_url: string;
+    theme_documentation_url: string;
+    config: ThemeFileInfo[];
+    layout: ThemeFileInfo[];
+    sections: ThemeFileInfo[];
+    templates: ThemeFileInfo[];
+    locales: ThemeFileInfo[];
+    snippets: ThemeFileInfo[];
+    assets: ThemeFileInfo[];
+}

package/dist/lib/core/themes/preview.d.ts

@@ -0,0 +1 @@
+export default function previewTheme(url: string): Promise<void>;

package/dist/lib/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/utils/common.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { PathLike } from 'fs';
+export declare const homeDir: string;
+/**
+ * Get youcan token from $HOME/.youcan file
+ * @returns string - youcan token
+ */
+export declare function getUserToken(): Promise<string>;
+export declare function getCurrentThemeId(dir: PathLike): Promise<string | null>;
+export declare class LoadingSpinner {
+    private message;
+    timer: NodeJS.Timer | null;
+    constructor(message: string);
+    start(): this;
+    private flush;
+    stop(): this;
+    error(message?: string | null): this;
+    static exec(message: string, closure: (spinner: LoadingSpinner) => Promise<void>): Promise<void>;
+}
+export declare function delay(ms: number): Promise<void>;

package/dist/lib/utils/git/cloneRepository.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Clone a git repository
+ * @param url - URL to open
+ * @param folder
+ */
+export default function cloneRepository(url: string, folder: string): boolean;

package/dist/lib/utils/helpers.d.ts

@@ -0,0 +1,3 @@
+export declare function stripln(buffer: string, ln: number): string;
+export declare function splitln(buffer: string, limit: number): string[];
+export declare function getcols(buffer: string, indices: number[], limit?: number | null): string[][];

package/dist/lib/utils/http.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { Agent } from 'https';
+import type { RequestInit } from 'node-fetch';
+export declare const DEFAULT_HTTP_CLIENT_OPTIONS: {
+    headers: {
+        Accept: string;
+    };
+    agent: Agent;
+};
+export declare function get<T>(endpoint: string, options?: RequestInit): Promise<T>;
+export declare function post<T>(endpoint: string, options?: RequestInit): Promise<T>;

package/dist/lib/utils/network.d.ts

@@ -0,0 +1,2 @@
+export declare function isPortAvailable(port: string | number): Promise<boolean>;
+export declare function getPidByPort(port: number | string): Promise<number | null>;

package/dist/lib/utils/system/deleteFile.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @param filePath - The path of the file to delete.
+ *
+*/
+export default function deleteFile(filePath: string): void;

package/dist/lib/utils/system/openLink.d.ts

@@ -0,0 +1 @@
+export default function openLink(url: string): void;

package/dist/lib/utils/system/saveFile.d.ts

@@ -0,0 +1 @@
+export declare function saveHttpFile(res: any, filename: string): Promise<void>;

package/dist/lib/utils/system/stdout.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Print to standard output with meaningful colors
+ */
+declare function log(arg: string): void;
+declare function info(arg: string): void;
+declare function warn(arg: string): void;
+declare function error(arg: string): void;
+declare function success(arg: string): void;
+declare function clear(): void;
+declare const _default: {
+    log: typeof log;
+    info: typeof info;
+    warn: typeof warn;
+    error: typeof error;
+    clear: typeof clear;
+    success: typeof success;
+};
+export default _default;

package/dist/lib/utils/system/writeToFile.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @param filePath - The path to the file to write to.
+ * @param content - The content to write to the file.
+ * @returns A promise that resolves when the file has been written.
+*/
+export default function writeToFile(filePath: string, content: string): void;

package/dist/lib/utils/system/zipFolder.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Zip folder and save it to a given path and return zip folder path
+ */
+export default function zipFolder(folderPath: string, folderName: string): Promise<string>;

package/dist/lib/utils/system.d.ts

@@ -0,0 +1 @@
+export declare const kill: (pid: number, signal?: string, timeout?: number) => Promise<void>;

package/dist/test/commands/auth/login.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => void;
+export default _default;

package/dist/test/commands/auth/logout.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => void;
+export default _default;

package/dist/test/commands/help.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => void;
+export default _default;

package/dist/test/commands/theme/delete.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => void;
+export default _default;

package/dist/test/commands/theme/dev.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => void;
+export default _default;

package/dist/test/commands/theme/init.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => void;
+export default _default;

package/dist/test/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/common.js

@@ -0,0 +1,57 @@
+import os from 'os';
+import fs from 'fs';
+import path from 'path';
+import kleur from 'kleur';
+
+os.homedir();
+async function getCurrentThemeId(dir) {
+    const filepath = path.resolve(dir.toString(), '.youcan');
+    if (!fs.existsSync(filepath))
+        return null;
+    return await fs.promises.readFile(filepath, 'utf-8')
+        .then(b => JSON.parse(b).theme_id);
+}
+class LoadingSpinner {
+    constructor(message) {
+        this.message = message;
+        this.message = message;
+        this.timer = null;
+    }
+    start() {
+        process.stdout.write('\x1B[?25l');
+        const frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
+        let i = 0;
+        this.timer = setInterval(() => {
+            process.stdout.write(`\r${frames[i = ++i % frames.length]} ${this.message}`);
+        }, 100);
+        return this;
+    }
+    flush() {
+        if (this.timer) {
+            clearInterval(this.timer);
+            this.timer = null;
+        }
+    }
+    stop() {
+        this.flush();
+        process.stdout.write('\r');
+        process.stdout.write(kleur.green(`✔ ${this.message}\n`));
+        return this;
+    }
+    error(message = null) {
+        this.flush();
+        process.stdout.write('\r');
+        process.stdout.write(kleur.red(`✖ ${message !== null && message !== void 0 ? message : this.message}\n`));
+        return this;
+    }
+    static async exec(message, closure) {
+        const spinner = new LoadingSpinner(message).start();
+        await closure(spinner);
+        spinner.timer && spinner.stop();
+    }
+}
+function delay(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+export { LoadingSpinner, delay, getCurrentThemeId };

package/dist/utils/git/cloneRepository.js

@@ -0,0 +1,18 @@
+import { execSync } from 'child_process';
+
+/**
+ * Clone a git repository
+ * @param url - URL to open
+ * @param folder
+ */
+function cloneRepository(url, folder) {
+    try {
+        execSync(`git clone '${url}' '${folder}'`);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+
+export { cloneRepository as default };

package/dist/utils/helpers.js

@@ -0,0 +1,32 @@
+function stripln(buffer, ln) {
+    let index = 0;
+    while (ln-- > 0) {
+        const lfIndex = buffer.indexOf('\n', index);
+        if (lfIndex >= 0)
+            index = lfIndex + 1;
+    }
+    return index > 0 ? buffer.substring(index) : buffer;
+}
+function splitln(buffer, limit) {
+    const cols = buffer.trim().split(/\s+/);
+    if (cols.length > limit)
+        cols[limit - 1] = cols.slice(limit - 1).join(' ');
+    return cols;
+}
+function getcols(buffer, indices, limit = null) {
+    const lines = buffer.split(/(\r\n|\n|\r)/);
+    const cols = [];
+    if (!limit)
+        limit = Math.max.apply(null, indices) + 1;
+    lines.forEach((ln) => {
+        const lncols = splitln(ln, limit);
+        const lncol = [];
+        indices.forEach((index) => {
+            lncol.push(lncols[index] || '');
+        });
+        cols.push(lncol);
+    });
+    return cols;
+}
+
+export { getcols, splitln, stripln };

package/dist/utils/http.js

@@ -0,0 +1,25 @@
+import { Agent } from 'https';
+import fetch from 'node-fetch';
+import { mergeDeepLeft } from 'ramda';
+
+const HttpsAgent = new Agent({ keepAlive: true, keepAliveMsecs: 5 * 60 * 1000 });
+const DEFAULT_HTTP_CLIENT_OPTIONS = {
+    headers: {
+        Accept: 'application/json',
+    },
+    agent: HttpsAgent,
+};
+async function request(endpoint, options = {}) {
+    const response = await fetch(endpoint, mergeDeepLeft(options, DEFAULT_HTTP_CLIENT_OPTIONS));
+    if (!response.ok)
+        throw new Error(await response.text(), { cause: response });
+    return response.json();
+}
+async function get(endpoint, options = {}) {
+    return request(endpoint, { ...options, method: 'GET' });
+}
+async function post(endpoint, options = {}) {
+    return request(endpoint, { ...options, method: 'POST' });
+}
+
+export { DEFAULT_HTTP_CLIENT_OPTIONS, get, post };