twenty-sdk 0.3.1 → 0.4.0

package/dist/cli/utilities/build/common/front-component-build/react-globals-plugin.d.ts

@@ -0,0 +1,2 @@
+import type * as esbuild from 'esbuild';
+export declare const reactGlobalsPlugin: esbuild.Plugin;

package/dist/cli/utilities/build/common/front-component-build/types/ParsedImportSpecifier.d.ts

@@ -0,0 +1,4 @@
+export type ParsedImportSpecifier = {
+    originalName: string;
+    aliasName: string;
+};

package/dist/cli/utilities/build/common/front-component-build/utils/extract-names-from-import-specifier.d.ts

@@ -0,0 +1,2 @@
+import { ParsedImportSpecifier } from '../types/ParsedImportSpecifier';
+export declare const extractNamesFromImportSpecifier: (importSpecifier: string) => ParsedImportSpecifier;

package/dist/cli/utilities/build/common/front-component-build/utils/replace-html-tags-with-remote-components.d.ts

@@ -0,0 +1 @@
+export declare const replaceHtmlTagsWithRemoteComponents: (sourceCode: string) => string;

package/dist/cli/utilities/build/common/front-component-build/utils/unwrap-define-front-component-to-direct-export.d.ts

@@ -0,0 +1 @@
+export declare const unwrapDefineFrontComponentToDirectExport: (sourceCode: string) => string;

package/dist/cli/utilities/build/common/restartable-watcher-interface.d.ts

@@ -0,0 +1,25 @@
+import { FileFolder } from '../../../../vendor/twenty-shared/types';
+import { Location } from 'esbuild';
+export interface RestartableWatcher {
+    restart(sourcePaths: string[]): Promise<void>;
+    start(): Promise<void>;
+    close(): Promise<void>;
+    shouldRestart(sourcePaths: string[]): boolean;
+}
+export type OnFileBuiltCallback = (options: {
+    fileFolder: FileFolder;
+    builtPath: string;
+    sourcePath: string;
+    checksum: string;
+}) => void | Promise<void>;
+export type OnBuildErrorCallback = (errors: {
+    error: string;
+    location: Location | null;
+}[]) => void | Promise<void>;
+export type RestartableWatcherOptions = {
+    appPath: string;
+    sourcePaths: string[];
+    watch?: boolean;
+    handleFileBuilt: OnFileBuiltCallback;
+    handleBuildError: OnBuildErrorCallback;
+};

package/dist/cli/utilities/build/manifest/manifest-build.d.ts

@@ -0,0 +1,7 @@
+import { EntityFilePaths } from './manifest-extract-config';
+import { Manifest } from '../../../../vendor/twenty-shared/application';
+export declare const buildManifest: (appPath: string) => Promise<{
+    manifest: Manifest | null;
+    filePaths: EntityFilePaths;
+    errors: string[];
+}>;

package/dist/cli/utilities/build/manifest/manifest-extract-config-from-file.d.ts

@@ -0,0 +1,5 @@
+import { ValidationResult } from '../../../../sdk';
+export declare const extractManifestFromFile: <T>({ filePath, appPath, }: {
+    filePath: string;
+    appPath: string;
+}) => Promise<ValidationResult<T>>;

package/dist/cli/utilities/build/manifest/manifest-extract-config.d.ts

@@ -0,0 +1,20 @@
+export declare enum TargetFunction {
+    DefineApplication = "defineApplication",
+    DefineField = "defineField",
+    DefineLogicFunction = "defineLogicFunction",
+    DefineObject = "defineObject",
+    DefineRole = "defineRole",
+    DefineFrontComponent = "defineFrontComponent"
+}
+export declare enum ManifestEntityKey {
+    Application = "application",
+    Fields = "fields",
+    LogicFunctions = "logicFunctions",
+    Objects = "objects",
+    Roles = "roles",
+    FrontComponents = "frontComponents",
+    PublicAssets = "publicAssets"
+}
+export type EntityFilePaths = Record<ManifestEntityKey, string[]>;
+export declare const TARGET_FUNCTION_TO_ENTITY_KEY_MAPPING: Record<TargetFunction, ManifestEntityKey>;
+export declare const extractDefineEntity: (fileContent: string) => TargetFunction | undefined;

package/dist/cli/utilities/build/manifest/manifest-types.d.ts

@@ -0,0 +1,4 @@
+export type ValidationError = {
+    path: string;
+    message: string;
+};

package/dist/cli/utilities/build/manifest/manifest-update-checksums.d.ts

@@ -0,0 +1,17 @@
+import { Manifest } from '../../../../vendor/twenty-shared/application';
+import { FileFolder } from '../../../../vendor/twenty-shared/types';
+import { EntityFilePaths } from './manifest-extract-config';
+export type ManifestBuildResult = {
+    manifest: Manifest | null;
+    filePaths: EntityFilePaths;
+    error?: string;
+};
+export type UpdateManifestChecksumParams = {
+    manifest: Manifest;
+    builtFileInfos: Map<string, {
+        checksum: string;
+        builtPath: string;
+        fileFolder: FileFolder;
+    }>;
+};
+export declare const manifestUpdateChecksums: ({ manifest, builtFileInfos, }: UpdateManifestChecksumParams) => Manifest;

package/dist/cli/utilities/build/manifest/manifest-validate.d.ts

@@ -0,0 +1,6 @@
+import { Manifest } from '../../../../vendor/twenty-shared/application';
+export declare const manifestValidate: (manifest: Manifest) => {
+    errors: string[];
+    warnings: string[];
+    isValid: boolean;
+};

package/dist/cli/utilities/build/manifest/manifest-watcher.d.ts

@@ -0,0 +1,12 @@
+export type ManifestWatcherOptions = {
+    appPath: string;
+    handleChangeDetected: (filePath: string) => void;
+};
+export declare class ManifestWatcher {
+    private appPath;
+    private handleChangeDetected;
+    private watcher;
+    constructor(options: ManifestWatcherOptions);
+    start(): Promise<void>;
+    close(): Promise<void>;
+}

package/dist/cli/utilities/build/manifest/manifest-writer.d.ts

@@ -0,0 +1,2 @@
+import { Manifest } from '../../../../vendor/twenty-shared/application';
+export declare const writeManifestToOutput: (appPath: string, manifest: Manifest) => Promise<string>;

package/dist/cli/{services/generate.service.d.ts → utilities/client/client-service.d.ts}

@@ -1,8 +1,8 @@
 export declare const GENERATED_FOLDER_NAME = "generated";
-export declare class GenerateService {
+export declare class ClientService {
     private configService;
     private apiService;
     constructor();
-    generateClient(appPath: string): Promise<void>;
+    generate(appPath: string): Promise<void>;
     private injectTwentyClient;
 }

package/dist/cli/{services/config.service.d.ts → utilities/config/config-service.d.ts}

@@ -11,7 +11,11 @@ export declare class ConfigService {
     private getActiveWorkspaceName;
     private readRawConfig;
     getConfig(): Promise<TwentyConfig>;
+    getConfigForWorkspace(workspaceName: string): Promise<TwentyConfig>;
     setConfig(config: Partial<TwentyConfig>): Promise<void>;
     clearConfig(): Promise<void>;
     private getDefaultConfig;
+    getAvailableWorkspaces(): Promise<string[]>;
+    getDefaultWorkspace(): Promise<string>;
+    setDefaultWorkspace(name: string): Promise<void>;
 }

package/dist/cli/utilities/dev/dev-mode-orchestrator.d.ts

@@ -0,0 +1,42 @@
+import { ManifestBuildResult } from '../build/manifest/manifest-update-checksums';
+import { FileFolder } from '../../../vendor/twenty-shared/types';
+import { Location } from 'esbuild';
+import { DevUiStateManager } from './dev-ui-state-manager';
+import { EventName } from 'chokidar/handler.js';
+export type DevModeOrchestratorOptions = {
+    appPath: string;
+    debounceMs?: number;
+    handleManifestBuilt: (result: ManifestBuildResult) => void | Promise<void>;
+    uiStateManager: DevUiStateManager;
+};
+export declare class DevModeOrchestrator {
+    private appPath;
+    private debounceMs;
+    private builtFileInfos;
+    private fileUploader;
+    private apiService;
+    private activeUploads;
+    private syncTimer;
+    private isSyncing;
+    private uiStateManager;
+    private serverReady;
+    private serverErrorLogged;
+    private handleManifestBuilt;
+    constructor(options: DevModeOrchestratorOptions);
+    private checkServer;
+    handleChangeDetected(sourcePath: string, event: EventName): Promise<void>;
+    handleFileBuildError(errors: {
+        error: string;
+        location: Location | null;
+    }[]): void;
+    handleFileBuilt({ fileFolder, builtPath, sourcePath, checksum, }: {
+        fileFolder: FileFolder;
+        builtPath: string;
+        sourcePath: string;
+        checksum: string;
+    }): void;
+    private uploadFile;
+    private cancelPendingSync;
+    private scheduleSync;
+    private performSync;
+}

package/dist/cli/utilities/dev/dev-ui-state-manager.d.ts

@@ -0,0 +1,31 @@
+import { SyncableEntity } from '../../../vendor/twenty-shared/application';
+import { FileStatus, Listener, ManifestStatus, UiEvent, DevUiState } from './dev-ui-state';
+import { EntityFilePaths } from '../build/manifest/manifest-extract-config';
+export declare class DevUiStateManager {
+    private state;
+    private eventIdCounter;
+    private listeners;
+    constructor({ appPath, frontendUrl, }: {
+        appPath: string;
+        frontendUrl?: string;
+    });
+    getSnapshot(): DevUiState;
+    subscribe(listener: Listener): () => void;
+    private notify;
+    addEvent({ message, status, }: {
+        message: string;
+        status: UiEvent['status'];
+    }): void;
+    updateManifestState({ manifestStatus, appName, error, }: {
+        manifestStatus?: ManifestStatus;
+        appName?: string;
+        error?: string;
+    }): void;
+    convertEntityTypeToSyncableEntity(entityType: string): SyncableEntity | undefined;
+    updateAllFilesTypes({ manifestFilePaths, }: {
+        manifestFilePaths: EntityFilePaths;
+    }): void;
+    updateAllFilesStatus(status: FileStatus): void;
+    removeEntity(filePath: string): void;
+    updateFileStatus(filePath: string, status: FileStatus): void;
+}

package/dist/cli/utilities/dev/dev-ui-state.d.ts

@@ -0,0 +1,27 @@
+import { SyncableEntity } from '../../../vendor/twenty-shared/application';
+export type UiEvent = {
+    id: number;
+    timestamp: Date;
+    message: string;
+    status: 'info' | 'success' | 'error' | 'warning';
+};
+export type ManifestStatus = 'idle' | 'building' | 'syncing' | 'synced' | 'error';
+export type FileStatus = 'pending' | 'building' | 'uploading' | 'success';
+export type EntityInfo = {
+    name: string;
+    path: string;
+    type?: SyncableEntity;
+    status: FileStatus;
+};
+export type DevUiState = {
+    appPath: string;
+    appName: string | null;
+    appDescription: string | null;
+    appUniversalIdentifier: string | null;
+    frontendUrl?: string | null;
+    manifestStatus: ManifestStatus;
+    error?: string | null;
+    entities: Map<string, EntityInfo>;
+    events: UiEvent[];
+};
+export type Listener = (state: DevUiState) => void;

package/dist/cli/utilities/dev/dev-ui.d.ts

@@ -0,0 +1,4 @@
+import { DevUiStateManager } from './dev-ui-state-manager';
+export declare const renderDevUI: (uiStateManager: DevUiStateManager) => Promise<{
+    unmount: () => void;
+}>;

package/dist/cli/utilities/entity/entity-field-template.d.ts

@@ -0,0 +1,11 @@
+import { FieldMetadataType } from '../../../vendor/twenty-shared/types';
+export declare const getFieldBaseFile: ({ data, }: {
+    data: {
+        name: string;
+        label: string;
+        type: FieldMetadataType;
+        objectUniversalIdentifier: string;
+        description?: string;
+    };
+    name: string;
+}) => string;

package/dist/cli/utilities/entity/entity-front-component-template.d.ts

@@ -0,0 +1,4 @@
+export declare const getFrontComponentBaseFile: ({ name, universalIdentifier, }: {
+    name: string;
+    universalIdentifier?: string;
+}) => string;

package/dist/cli/utilities/entity/entity-logic-function-template.d.ts

@@ -0,0 +1,4 @@
+export declare const getLogicFunctionBaseFile: ({ name, universalIdentifier, }: {
+    name: string;
+    universalIdentifier?: string;
+}) => string;

package/dist/cli/{utils/get-new-object-file-content.d.ts → utilities/entity/entity-object-template.d.ts}

@@ -1,4 +1,4 @@
-export declare const getNewObjectFileContent: ({ data, }: {
+export declare const getObjectBaseFile: ({ data, }: {
     data: {
         nameSingular: string;
         namePlural: string;

package/dist/cli/{utils/jsonc-parser.d.ts → utilities/file/file-jsonc.d.ts}

@@ -10,8 +10,4 @@ export declare class JsoncParseError extends Error {
     constructor(message: string, parseErrors: ParseError[], filePath?: string | undefined);
 }
 export declare const parseJsoncString: (content: string, options?: JsoncParseOptions) => any;
-export declare const parseTextFile: (filePath: string) => Promise<string>;
-export declare const parseJsoncFile: (filePath: string, options?: JsoncParseOptions) => Promise<any>;
-export declare const writeJsoncFile: (filePath: string, data: any, options?: {
-    spaces?: number;
-}) => Promise<void>;
+export declare const parseJsoncFile: <T = object>(filePath: string, options?: JsoncParseOptions) => Promise<T>;

package/dist/cli/utilities/file/file-tarball.d.ts

@@ -0,0 +1,16 @@
+/**
+ * TarballService creates distributable .tar.gz archives from built applications.
+ */
+export declare class TarballService {
+    /**
+     * Create a tarball from the build output directory.
+     *
+     * @param sourceDir - The directory containing built files
+     * @param outputPath - The path for the output .tar.gz file
+     * @returns The absolute path to the created tarball
+     */
+    create(options: {
+        sourceDir: string;
+        outputPath: string;
+    }): Promise<string>;
+}

package/dist/cli/utilities/file/file-uploader.d.ts

@@ -0,0 +1,14 @@
+import { FileFolder } from '../../../vendor/twenty-shared/types';
+export declare class FileUploader {
+    private apiService;
+    private applicationUniversalIdentifier;
+    private appPath;
+    constructor(options: {
+        applicationUniversalIdentifier: string;
+        appPath: string;
+    });
+    uploadFile({ builtPath, fileFolder, }: {
+        builtPath: string;
+        fileFolder: FileFolder;
+    }): Promise<import('../api/api-response-type').ApiResponse<boolean>>;
+}

package/dist/cli/{utils/get-ts-program-and-diagnostics.d.ts → utilities/typescript/typescript-program.d.ts}

@@ -1,4 +1,4 @@
-import { Program, Diagnostic } from 'typescript';
+import { Diagnostic, Program } from 'typescript';
 export declare const getTsProgramAndDiagnostics: ({ appPath, }: {
     appPath: string;
 }) => Promise<{