UNPKG

3.1 kBTypeScriptView Raw
1import Command from '@oclif/command';
2import { IStoryblokConfig } from './config/config';
3export default abstract class extends Command {
4 storyblokConfig(): IStoryblokConfig;
5 files(): {
6 getCurrentDirectoryBase: () => string;
7 isDirectoryExists: (path: string) => boolean;
8 createDir: (dirPath: string) => Promise<void>;
9 createJsonFile: (content: string, pathWithFilename: string) => Promise<void>;
10 copyFolder: (src: string, dest: string) => Promise<unknown>;
11 copyFile: (src: string, dest: string) => Promise<void>;
12 };
13 api(): {
14 discover: {
15 findComponents: (componentDirectory: string) => any[];
16 findComponentsWithExt: (ext: string) => any[];
17 findDatasources: () => any[];
18 };
19 datasources: {
20 getAllDatasources: () => Promise<any>;
21 getDatasource: (datasourceName: string) => Promise<any>;
22 getDatasourceEntries: (datasourceName: string) => Promise<any>;
23 createDatasource: (datasource: any) => Promise<void | {
24 data: any;
25 datasource_entries: any;
26 }>;
27 createDatasourceEntry: (datasourceEntry: any, datasourceId: string) => Promise<any>;
28 updateDatasourceEntry: (datasourceEntry: any, datasourceId: string, datasourceToBeUpdated: any) => Promise<any>;
29 updateDatasource: (datasource: any, temp: any) => Promise<void | {
30 data: any;
31 datasource_entries: any;
32 }>;
33 createDatasourceEntries: (datasourceId: string, datasource_entries: any, remoteDatasourceEntries: any) => void;
34 syncDatasources: (specifiedDatasources: any) => Promise<void>;
35 };
36 components: {
37 getAllComponents: () => Promise<any>;
38 getComponent: (componentName: string) => Promise<any>;
39 getComponentsGroup: (groupName: string) => Promise<any>;
40 getAllComponentsGroups: () => Promise<any>;
41 createComponentsGroup: (groupName: string) => Promise<any>;
42 syncComponents: (specifiedComponents: any, ext: string | false, presets: boolean) => Promise<void>;
43 syncAllComponents: (ext: string | false, presets: boolean) => void;
44 updateComponent: (component: any, presets: boolean) => void;
45 createComponent: (component: any, presets: boolean) => void;
46 };
47 presets: {
48 getComponentPresets: (componentName: string) => Promise<false | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>;
49 getPreset: (presetId: string) => Promise<any>;
50 getAllPresets: () => Promise<any>;
51 createPreset: (p: any) => void;
52 updatePreset: (p: any) => void;
53 };
54 spaces: {
55 createSpace: (spaceName: string) => Promise<void | import("./types/storyblokTypes").StoryblokManagmentApiResult>;
56 getSpace: (spaceId: string) => Promise<import("./types/storyblokTypes").StoryblokResult>;
57 };
58 };
59}