@elek-io/core 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as _elek_io_shared from '@elek-io/shared';
-import { ServiceType, ElekIoCoreOptions, BaseFile, GitTag, Sort, PaginatedList, ObjectType, FileReference, ExtendedCrudService, CreateGitTagProps, ReadGitTagProps, DeleteGitTagProps, ListGitTagsProps, CountGitTagsProps, UserFile, User, SetUserProps, GitInitOptions, GitCloneOptions, GitSwitchOptions, GitLogOptions, GitCommit, Asset, CreateAssetProps, ReadAssetProps, UpdateAssetProps, DeleteAssetProps, ListAssetsProps, CountAssetsProps, Collection, CreateCollectionProps, ReadCollectionProps, UpdateCollectionProps, DeleteCollectionProps, ListCollectionsProps, CountCollectionsProps, SharedValue, CreateSharedValueProps, ReadSharedValueProps, UpdateSharedValueProps, DeleteSharedValueProps, ListSharedValuesProps, CountValuesProps, Entry, CreateEntryProps, ReadEntryProps, UpdateEntryProps, DeleteEntryProps, ListEntriesProps, CountEntriesProps, Project, CreateProjectProps, ReadProjectProps, UpdateProjectProps, UpgradeProjectProps, DeleteProjectProps, ListProjectsProps, ProjectExport, ConstructorElekIoCoreProps } from '@elek-io/shared';
+import { ServiceType, ElekIoCoreOptions, BaseFile, GitTag, Sort, PaginatedList, ObjectType, FileReference, ExtendedCrudService, CreateGitTagProps, ReadGitTagProps, DeleteGitTagProps, ListGitTagsProps, CountGitTagsProps, UserFile, User, SetUserProps, GitInitOptions, GitCloneOptions, GitSwitchOptions, GitLogOptions, GitCommit, Asset, CreateAssetProps, ReadAssetProps, UpdateAssetProps, DeleteAssetProps, ListAssetsProps, CountAssetsProps, Collection, CreateCollectionProps, ReadCollectionProps, UpdateCollectionProps, DeleteCollectionProps, ListCollectionsProps, CountCollectionsProps, Entry, CreateEntryProps, ReadEntryProps, UpdateEntryProps, DeleteEntryProps, ListEntriesProps, CountEntriesProps, Project, CreateProjectProps, ReadProjectProps, UpdateProjectProps, UpgradeProjectProps, DeleteProjectProps, ListProjectsProps, ProjectExport, ConstructorElekIoCoreProps } from '@elek-io/shared';
 import { z } from 'zod';
 import { SpawnOptionsWithoutStdio } from 'child_process';
 import Fs from 'fs-extra';
@@ -459,43 +459,6 @@ declare class CollectionService extends AbstractCrudService implements ExtendedC
     isCollection(obj: BaseFile | unknown): obj is Collection;
 }
 
-/**
- * Service that manages CRUD functionality for shared Value files on disk
- */
-declare class SharedValueService extends AbstractCrudService implements ExtendedCrudService<SharedValue> {
-    private jsonFileService;
-    private gitService;
-    constructor(options: ElekIoCoreOptions, jsonFileService: JsonFileService, gitService: GitService, assetService: AssetService);
-    /**
-     * Creates a new shared Value
-     */
-    create(props: CreateSharedValueProps): Promise<SharedValue>;
-    /**
-     * Returns a shared Value by ID and language
-     */
-    read(props: ReadSharedValueProps): Promise<SharedValue>;
-    /**
-     * Updates given shared Values content
-     *
-     * The valueType cannot be changed after creating the shared Value
-     */
-    update(props: UpdateSharedValueProps): Promise<SharedValue>;
-    /**
-     * Deletes given shared Value
-     */
-    delete(props: DeleteSharedValueProps): Promise<void>;
-    list(props: ListSharedValuesProps): Promise<PaginatedList<SharedValue>>;
-    count(props: CountValuesProps): Promise<number>;
-    /**
-     * Checks if given object is a shared Value
-     */
-    isSharedValue(obj: BaseFile | unknown): obj is SharedValue;
-    /**
-     * Reads the given shared Values content based on it's ValueType
-     */
-    private validate;
-}
-
 /**
  * Service that manages CRUD functionality for Entry files on disk
  */
@@ -504,8 +467,7 @@ declare class EntryService extends AbstractCrudService implements ExtendedCrudSe
     private gitService;
     private collectionService;
     private assetService;
-    private sharedValueService;
-    constructor(options: ElekIoCoreOptions, jsonFileService: JsonFileService, gitService: GitService, collectionService: CollectionService, assetService: AssetService, sharedValueService: SharedValueService);
+    constructor(options: ElekIoCoreOptions, jsonFileService: JsonFileService, gitService: GitService, collectionService: CollectionService, assetService: AssetService);
     /**
      * Creates a new Entry for given Collection
      */
@@ -522,58 +484,7 @@ declare class EntryService extends AbstractCrudService implements ExtendedCrudSe
      * Deletes given Entry from it's Collection
      */
     delete(props: DeleteEntryProps): Promise<void>;
-    list(props: ListEntriesProps): Promise<_elek_io_shared.PaginatedList<{
-        values: ({
-            objectType: "value";
-            valueType: "string" | "number" | "boolean";
-            definitionId: string;
-            content?: string | number | boolean | undefined;
-        } | {
-            objectType: "value";
-            valueType: "reference";
-            content: {
-                referenceObjectType: "asset";
-                references: {
-                    id: string;
-                    language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "hu" | "it" | "ja" | "lt" | "lv" | "nl" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "zh";
-                    resolved: {
-                        extension: "avif" | "gif" | "jpg" | "jpeg" | "png" | "svg" | "webp" | "pdf" | "zip" | "mp4" | "webm" | "flac" | "json";
-                        mimeType: "image/avif" | "image/gif" | "image/jpeg" | "image/png" | "image/svg+xml" | "image/webp" | "application/pdf" | "application/zip" | "video/mp4" | "video/webm" | "audio/webm" | "audio/flac";
-                        id: string;
-                        name: string;
-                        objectType: "asset";
-                        created: number;
-                        language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "hu" | "it" | "ja" | "lt" | "lv" | "nl" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "zh";
-                        description: string;
-                        size: number;
-                        absolutePath: string;
-                        updated?: number | undefined;
-                    };
-                }[];
-            } | {
-                referenceObjectType: "sharedValue";
-                references: {
-                    id: string;
-                    language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "hu" | "it" | "ja" | "lt" | "lv" | "nl" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "zh";
-                    resolved: {
-                        id: string;
-                        objectType: "sharedValue";
-                        created: number;
-                        language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "hu" | "it" | "ja" | "lt" | "lv" | "nl" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "zh";
-                        valueType: "string" | "number" | "boolean";
-                        updated?: number | undefined;
-                        content?: string | number | boolean | undefined;
-                    };
-                };
-            };
-            definitionId: string;
-        })[];
-        id: string;
-        objectType: "entry";
-        created: number;
-        language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "hu" | "it" | "ja" | "lt" | "lv" | "nl" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "zh";
-        updated?: number | undefined;
-    }>>;
+    list(props: ListEntriesProps): Promise<_elek_io_shared.PaginatedList<Entry>>;
     count(props: CountEntriesProps): Promise<number>;
     /**
      * Checks if given object is of type Entry
@@ -592,7 +503,7 @@ declare class EntryService extends AbstractCrudService implements ExtendedCrudSe
      */
     private resolveValueContentReference;
     private resolveValueContentReferenceToAsset;
-    private resolveValueContentReferenceToSharedValue;
+    private resolveValueContentReferenceToEntry;
     /**
      * Creates an Entry from given EntryFile by resolving it's Values
      */
@@ -739,7 +650,7 @@ declare const pathTo: {
     collection: (projectId: string, id: string) => string;
     collectionFile: (projectId: string, id: string) => string;
     entries: (projectId: string, collectionId: string) => string;
-    entryFile: (projectId: string, collectionId: string, id: string, language: string) => string;
+    entryFile: (projectId: string, collectionId: string, id: string) => string;
     sharedValues: (projectId: string) => string;
     sharedValueFile: (projectId: string, id: string, language: string) => string;
     assets: (projectId: string) => string;
@@ -833,7 +744,6 @@ declare class ElekIoCore {
     private readonly projectService;
     private readonly collectionService;
     private readonly entryService;
-    private readonly sharedValueService;
     constructor(props?: ConstructorElekIoCoreProps);
     /**
      * Utility / helper functions
@@ -859,10 +769,6 @@ declare class ElekIoCore {
      * CRUD methods to work with Entries
      */
     get entries(): EntryService;
-    /**
-     * CRUD methods to work with Values
-     */
-    get sharedValues(): SharedValueService;
 }
 
 export { ElekIoCore as default };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _elek_io_shared from '@elek-io/shared';
-import { ServiceType, ElekIoCoreOptions, BaseFile, GitTag, Sort, PaginatedList, ObjectType, FileReference, ExtendedCrudService, CreateGitTagProps, ReadGitTagProps, DeleteGitTagProps, ListGitTagsProps, CountGitTagsProps, UserFile, User, SetUserProps, GitInitOptions, GitCloneOptions, GitSwitchOptions, GitLogOptions, GitCommit, Asset, CreateAssetProps, ReadAssetProps, UpdateAssetProps, DeleteAssetProps, ListAssetsProps, CountAssetsProps, Collection, CreateCollectionProps, ReadCollectionProps, UpdateCollectionProps, DeleteCollectionProps, ListCollectionsProps, CountCollectionsProps, SharedValue, CreateSharedValueProps, ReadSharedValueProps, UpdateSharedValueProps, DeleteSharedValueProps, ListSharedValuesProps, CountValuesProps, Entry, CreateEntryProps, ReadEntryProps, UpdateEntryProps, DeleteEntryProps, ListEntriesProps, CountEntriesProps, Project, CreateProjectProps, ReadProjectProps, UpdateProjectProps, UpgradeProjectProps, DeleteProjectProps, ListProjectsProps, ProjectExport, ConstructorElekIoCoreProps } from '@elek-io/shared';
+import { ServiceType, ElekIoCoreOptions, BaseFile, GitTag, Sort, PaginatedList, ObjectType, FileReference, ExtendedCrudService, CreateGitTagProps, ReadGitTagProps, DeleteGitTagProps, ListGitTagsProps, CountGitTagsProps, UserFile, User, SetUserProps, GitInitOptions, GitCloneOptions, GitSwitchOptions, GitLogOptions, GitCommit, Asset, CreateAssetProps, ReadAssetProps, UpdateAssetProps, DeleteAssetProps, ListAssetsProps, CountAssetsProps, Collection, CreateCollectionProps, ReadCollectionProps, UpdateCollectionProps, DeleteCollectionProps, ListCollectionsProps, CountCollectionsProps, Entry, CreateEntryProps, ReadEntryProps, UpdateEntryProps, DeleteEntryProps, ListEntriesProps, CountEntriesProps, Project, CreateProjectProps, ReadProjectProps, UpdateProjectProps, UpgradeProjectProps, DeleteProjectProps, ListProjectsProps, ProjectExport, ConstructorElekIoCoreProps } from '@elek-io/shared';
 import { z } from 'zod';
 import { SpawnOptionsWithoutStdio } from 'child_process';
 import Fs from 'fs-extra';
@@ -459,43 +459,6 @@ declare class CollectionService extends AbstractCrudService implements ExtendedC
     isCollection(obj: BaseFile | unknown): obj is Collection;
 }
 
-/**
- * Service that manages CRUD functionality for shared Value files on disk
- */
-declare class SharedValueService extends AbstractCrudService implements ExtendedCrudService<SharedValue> {
-    private jsonFileService;
-    private gitService;
-    constructor(options: ElekIoCoreOptions, jsonFileService: JsonFileService, gitService: GitService, assetService: AssetService);
-    /**
-     * Creates a new shared Value
-     */
-    create(props: CreateSharedValueProps): Promise<SharedValue>;
-    /**
-     * Returns a shared Value by ID and language
-     */
-    read(props: ReadSharedValueProps): Promise<SharedValue>;
-    /**
-     * Updates given shared Values content
-     *
-     * The valueType cannot be changed after creating the shared Value
-     */
-    update(props: UpdateSharedValueProps): Promise<SharedValue>;
-    /**
-     * Deletes given shared Value
-     */
-    delete(props: DeleteSharedValueProps): Promise<void>;
-    list(props: ListSharedValuesProps): Promise<PaginatedList<SharedValue>>;
-    count(props: CountValuesProps): Promise<number>;
-    /**
-     * Checks if given object is a shared Value
-     */
-    isSharedValue(obj: BaseFile | unknown): obj is SharedValue;
-    /**
-     * Reads the given shared Values content based on it's ValueType
-     */
-    private validate;
-}
-
 /**
  * Service that manages CRUD functionality for Entry files on disk
  */
@@ -504,8 +467,7 @@ declare class EntryService extends AbstractCrudService implements ExtendedCrudSe
     private gitService;
     private collectionService;
     private assetService;
-    private sharedValueService;
-    constructor(options: ElekIoCoreOptions, jsonFileService: JsonFileService, gitService: GitService, collectionService: CollectionService, assetService: AssetService, sharedValueService: SharedValueService);
+    constructor(options: ElekIoCoreOptions, jsonFileService: JsonFileService, gitService: GitService, collectionService: CollectionService, assetService: AssetService);
     /**
      * Creates a new Entry for given Collection
      */
@@ -522,58 +484,7 @@ declare class EntryService extends AbstractCrudService implements ExtendedCrudSe
      * Deletes given Entry from it's Collection
      */
     delete(props: DeleteEntryProps): Promise<void>;
-    list(props: ListEntriesProps): Promise<_elek_io_shared.PaginatedList<{
-        values: ({
-            objectType: "value";
-            valueType: "string" | "number" | "boolean";
-            definitionId: string;
-            content?: string | number | boolean | undefined;
-        } | {
-            objectType: "value";
-            valueType: "reference";
-            content: {
-                referenceObjectType: "asset";
-                references: {
-                    id: string;
-                    language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "hu" | "it" | "ja" | "lt" | "lv" | "nl" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "zh";
-                    resolved: {
-                        extension: "avif" | "gif" | "jpg" | "jpeg" | "png" | "svg" | "webp" | "pdf" | "zip" | "mp4" | "webm" | "flac" | "json";
-                        mimeType: "image/avif" | "image/gif" | "image/jpeg" | "image/png" | "image/svg+xml" | "image/webp" | "application/pdf" | "application/zip" | "video/mp4" | "video/webm" | "audio/webm" | "audio/flac";
-                        id: string;
-                        name: string;
-                        objectType: "asset";
-                        created: number;
-                        language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "hu" | "it" | "ja" | "lt" | "lv" | "nl" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "zh";
-                        description: string;
-                        size: number;
-                        absolutePath: string;
-                        updated?: number | undefined;
-                    };
-                }[];
-            } | {
-                referenceObjectType: "sharedValue";
-                references: {
-                    id: string;
-                    language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "hu" | "it" | "ja" | "lt" | "lv" | "nl" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "zh";
-                    resolved: {
-                        id: string;
-                        objectType: "sharedValue";
-                        created: number;
-                        language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "hu" | "it" | "ja" | "lt" | "lv" | "nl" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "zh";
-                        valueType: "string" | "number" | "boolean";
-                        updated?: number | undefined;
-                        content?: string | number | boolean | undefined;
-                    };
-                };
-            };
-            definitionId: string;
-        })[];
-        id: string;
-        objectType: "entry";
-        created: number;
-        language: "bg" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "hu" | "it" | "ja" | "lt" | "lv" | "nl" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sv" | "zh";
-        updated?: number | undefined;
-    }>>;
+    list(props: ListEntriesProps): Promise<_elek_io_shared.PaginatedList<Entry>>;
     count(props: CountEntriesProps): Promise<number>;
     /**
      * Checks if given object is of type Entry
@@ -592,7 +503,7 @@ declare class EntryService extends AbstractCrudService implements ExtendedCrudSe
      */
     private resolveValueContentReference;
     private resolveValueContentReferenceToAsset;
-    private resolveValueContentReferenceToSharedValue;
+    private resolveValueContentReferenceToEntry;
     /**
      * Creates an Entry from given EntryFile by resolving it's Values
      */
@@ -739,7 +650,7 @@ declare const pathTo: {
     collection: (projectId: string, id: string) => string;
     collectionFile: (projectId: string, id: string) => string;
     entries: (projectId: string, collectionId: string) => string;
-    entryFile: (projectId: string, collectionId: string, id: string, language: string) => string;
+    entryFile: (projectId: string, collectionId: string, id: string) => string;
     sharedValues: (projectId: string) => string;
     sharedValueFile: (projectId: string, id: string, language: string) => string;
     assets: (projectId: string) => string;
@@ -833,7 +744,6 @@ declare class ElekIoCore {
     private readonly projectService;
     private readonly collectionService;
     private readonly entryService;
-    private readonly sharedValueService;
     constructor(props?: ConstructorElekIoCoreProps);
     /**
      * Utility / helper functions
@@ -859,10 +769,6 @@ declare class ElekIoCore {
      * CRUD methods to work with Entries
      */
     get entries(): EntryService;
-    /**
-     * CRUD methods to work with Values
-     */
-    get sharedValues(): SharedValueService;
 }
 
 export { ElekIoCore as default };