@silexlabs/silex 3.0.0-alpha.41 → 3.0.0-alpha.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (162) hide show
  1. package/.silex.js +2 -11
  2. package/dist/client/client/api.d.ts +83 -0
  3. package/dist/client/client/config.d.ts +3 -3
  4. package/dist/client/client/expose.d.ts +6 -0
  5. package/dist/client/client/grapesjs/LoginDialog.d.ts +3 -2
  6. package/dist/client/client/grapesjs/PublicationManager.d.ts +9 -3
  7. package/dist/client/client/grapesjs/PublicationUi.d.ts +9 -6
  8. package/dist/client/client/grapesjs/index.d.ts +4 -4
  9. package/dist/client/client/grapesjs/openImport.d.ts +5 -0
  10. package/dist/client/constants.d.ts +23 -14
  11. package/dist/client/events.d.ts +8 -0
  12. package/dist/client/js/main.js +90 -111
  13. package/dist/client/js/main.js.LICENSE.txt +0 -6
  14. package/dist/client/page.d.ts +1 -1
  15. package/dist/client/types.d.ts +125 -86
  16. package/dist/plugins/client/client/utils.d.ts +1 -0
  17. package/dist/{events.js → plugins/client/client/utils.js} +9 -6
  18. package/dist/plugins/client/client/utils.js.map +1 -0
  19. package/dist/plugins/client/events.d.ts +10 -0
  20. package/dist/plugins/client/events.js +27 -0
  21. package/dist/plugins/client/events.js.map +1 -0
  22. package/dist/plugins/client/plugins/client/template.d.ts +2 -0
  23. package/dist/plugins/client/plugins/client/template.js +186 -0
  24. package/dist/plugins/client/plugins/client/template.js.map +1 -0
  25. package/dist/plugins/server/constants.d.ts +30 -0
  26. package/dist/plugins/server/constants.js +50 -0
  27. package/dist/plugins/server/constants.js.map +1 -0
  28. package/dist/plugins/server/events.d.ts +10 -0
  29. package/dist/plugins/server/events.js +30 -0
  30. package/dist/plugins/server/events.js.map +1 -0
  31. package/dist/plugins/server/plugins/server/AuthPlugin.js.map +1 -0
  32. package/dist/plugins/server/plugins/server/Cache.js.map +1 -0
  33. package/dist/plugins/server/plugins/server/FtpConnector.d.ts +94 -0
  34. package/dist/plugins/server/plugins/server/FtpConnector.js +521 -0
  35. package/dist/plugins/server/plugins/server/FtpConnector.js.map +1 -0
  36. package/dist/plugins/{HooksPlugin.d.ts → server/plugins/server/HooksPlugin.d.ts} +1 -1
  37. package/dist/plugins/{HooksPlugin.js → server/plugins/server/HooksPlugin.js} +4 -6
  38. package/dist/plugins/server/plugins/server/HooksPlugin.js.map +1 -0
  39. package/dist/plugins/{SslPlugin.js → server/plugins/server/SslPlugin.js} +7 -7
  40. package/dist/plugins/server/plugins/server/SslPlugin.js.map +1 -0
  41. package/dist/plugins/{StaticPlugin.js → server/plugins/server/StaticPlugin.js} +8 -3
  42. package/dist/plugins/server/plugins/server/StaticPlugin.js.map +1 -0
  43. package/dist/{server → plugins/server/server}/config.d.ts +13 -12
  44. package/dist/{server → plugins/server/server}/config.js +44 -34
  45. package/dist/plugins/server/server/config.js.map +1 -0
  46. package/dist/plugins/server/server/connectors/FsHosting.d.ts +13 -0
  47. package/dist/plugins/server/server/connectors/FsHosting.js +55 -0
  48. package/dist/plugins/server/server/connectors/FsHosting.js.map +1 -0
  49. package/dist/plugins/server/server/connectors/FsStorage.d.ts +40 -0
  50. package/dist/{server/backends/FsBackend.js → plugins/server/server/connectors/FsStorage.js} +93 -125
  51. package/dist/plugins/server/server/connectors/FsStorage.js.map +1 -0
  52. package/dist/plugins/server/server/connectors/connectors.d.ts +83 -0
  53. package/dist/plugins/server/server/connectors/connectors.js +98 -0
  54. package/dist/plugins/server/server/connectors/connectors.js.map +1 -0
  55. package/dist/plugins/server/server/jobs.js.map +1 -0
  56. package/dist/{server → plugins/server/server}/utils/validation.js +3 -2
  57. package/dist/plugins/server/server/utils/validation.js.map +1 -0
  58. package/dist/plugins/server/types.d.ts +309 -0
  59. package/dist/{types.js → plugins/server/types.js} +18 -7
  60. package/dist/plugins/server/types.js.map +1 -0
  61. package/dist/server/constants.js +30 -0
  62. package/dist/server/events.js +13 -0
  63. package/dist/server/plugins/server/Cache.js +15 -0
  64. package/dist/server/server/api/api.js +20 -0
  65. package/dist/server/server/api/connectorApi.js +200 -0
  66. package/dist/server/server/api/publicationApi.js +116 -0
  67. package/dist/server/server/api/websiteApi.js +288 -0
  68. package/dist/server/{cli.js → server/cli.js} +2 -1
  69. package/dist/server/server/config.js +124 -0
  70. package/dist/server/server/connectors/FsHosting.js +37 -0
  71. package/dist/server/server/connectors/FsStorage.js +208 -0
  72. package/dist/server/server/connectors/connectors.js +65 -0
  73. package/dist/server/{express.js → server/express.js} +1 -0
  74. package/dist/server/{index.js → server/index.js} +6 -3
  75. package/dist/server/server/jobs.js +47 -0
  76. package/dist/server/server/utils/validation.js +15 -0
  77. package/dist/server/types.js +19 -0
  78. package/package.json +24 -14
  79. package/src/ts/client/api.ts +135 -0
  80. package/src/ts/client/config.ts +3 -3
  81. package/src/ts/client/expose.ts +11 -0
  82. package/src/ts/client/grapesjs/LoginDialog.ts +33 -32
  83. package/src/ts/client/grapesjs/PublicationManager.ts +86 -112
  84. package/src/ts/client/grapesjs/PublicationUi.ts +43 -33
  85. package/src/ts/client/grapesjs/eleventy.ts +4 -1
  86. package/src/ts/client/grapesjs/index.ts +6 -19
  87. package/src/ts/client/grapesjs/openImport.ts +5 -0
  88. package/src/ts/client/grapesjs/storage.ts +18 -14
  89. package/src/ts/client/index.ts +15 -10
  90. package/src/ts/constants.ts +24 -14
  91. package/src/ts/events.ts +8 -0
  92. package/src/ts/page.ts +1 -1
  93. package/src/ts/plugins/client/template.ts +196 -0
  94. package/src/ts/plugins/server/FtpConnector.ts +602 -0
  95. package/src/ts/plugins/{HooksPlugin.ts → server/HooksPlugin.ts} +2 -4
  96. package/src/ts/plugins/{SslPlugin.ts → server/SslPlugin.ts} +7 -7
  97. package/src/ts/plugins/{StaticPlugin.ts → server/StaticPlugin.ts} +7 -3
  98. package/src/ts/server/api/api.ts +19 -0
  99. package/src/ts/server/api/connectorApi.ts +322 -0
  100. package/src/ts/server/api/publicationApi.ts +179 -0
  101. package/src/ts/server/api/websiteApi.ts +397 -0
  102. package/src/ts/server/cli.ts +3 -1
  103. package/src/ts/server/config.ts +47 -36
  104. package/src/ts/server/connectors/FsHosting.ts +60 -0
  105. package/src/ts/server/connectors/FsStorage.ts +236 -0
  106. package/src/ts/server/connectors/connectors.ts +171 -0
  107. package/src/ts/server/express.ts +1 -0
  108. package/src/ts/server/index.ts +5 -5
  109. package/src/ts/server/jobs.test.ts +1 -0
  110. package/src/ts/server/utils/BackwardCompat.ts +1 -1
  111. package/src/ts/server/utils/validation.ts +3 -2
  112. package/src/ts/types.ts +93 -61
  113. package/dist/client/client/grapesjs/eleventy.d.ts +0 -1
  114. package/dist/client/client/grapesjs/template.d.ts +0 -1
  115. package/dist/client/client/services.d.ts +0 -35
  116. package/dist/constants.d.ts +0 -21
  117. package/dist/constants.js +0 -41
  118. package/dist/constants.js.map +0 -1
  119. package/dist/events.d.ts +0 -2
  120. package/dist/events.js.map +0 -1
  121. package/dist/plugins/AuthPlugin.js.map +0 -1
  122. package/dist/plugins/Cache.js.map +0 -1
  123. package/dist/plugins/FtpBackend.d.ts +0 -92
  124. package/dist/plugins/FtpBackend.js +0 -604
  125. package/dist/plugins/FtpBackend.js.map +0 -1
  126. package/dist/plugins/HooksPlugin.js.map +0 -1
  127. package/dist/plugins/PublicationPlugin.d.ts +0 -17
  128. package/dist/plugins/PublicationPlugin.js +0 -170
  129. package/dist/plugins/PublicationPlugin.js.map +0 -1
  130. package/dist/plugins/SslPlugin.js.map +0 -1
  131. package/dist/plugins/StaticPlugin.js.map +0 -1
  132. package/dist/plugins/WebsitePlugin.d.ts +0 -14
  133. package/dist/plugins/WebsitePlugin.js +0 -302
  134. package/dist/plugins/WebsitePlugin.js.map +0 -1
  135. package/dist/server/backends/FsBackend.d.ts +0 -42
  136. package/dist/server/backends/FsBackend.js.map +0 -1
  137. package/dist/server/backends/index.d.ts +0 -95
  138. package/dist/server/backends/index.js +0 -255
  139. package/dist/server/backends/index.js.map +0 -1
  140. package/dist/server/config.js.map +0 -1
  141. package/dist/server/jobs.js.map +0 -1
  142. package/dist/server/utils/validation.js.map +0 -1
  143. package/dist/types.d.ts +0 -270
  144. package/dist/types.js.map +0 -1
  145. package/src/ts/client/grapesjs/template.ts +0 -183
  146. package/src/ts/client/services.ts +0 -129
  147. package/src/ts/plugins/FtpBackend.ts +0 -689
  148. package/src/ts/plugins/PublicationPlugin.ts +0 -170
  149. package/src/ts/plugins/WebsitePlugin.ts +0 -318
  150. package/src/ts/server/backends/FsBackend.ts +0 -266
  151. package/src/ts/server/backends/index.ts +0 -309
  152. /package/dist/plugins/{AuthPlugin.d.ts → server/plugins/server/AuthPlugin.d.ts} +0 -0
  153. /package/dist/plugins/{AuthPlugin.js → server/plugins/server/AuthPlugin.js} +0 -0
  154. /package/dist/plugins/{Cache.d.ts → server/plugins/server/Cache.d.ts} +0 -0
  155. /package/dist/plugins/{Cache.js → server/plugins/server/Cache.js} +0 -0
  156. /package/dist/plugins/{SslPlugin.d.ts → server/plugins/server/SslPlugin.d.ts} +0 -0
  157. /package/dist/plugins/{StaticPlugin.d.ts → server/plugins/server/StaticPlugin.d.ts} +0 -0
  158. /package/dist/{server → plugins/server/server}/jobs.d.ts +0 -0
  159. /package/dist/{server → plugins/server/server}/jobs.js +0 -0
  160. /package/dist/{server → plugins/server/server}/utils/validation.d.ts +0 -0
  161. /package/src/ts/plugins/{AuthPlugin.ts → server/AuthPlugin.ts} +0 -0
  162. /package/src/ts/plugins/{Cache.ts → server/Cache.ts} +0 -0
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ /*
3
+ * Silex website builder, free/libre no-code tool for makers.
4
+ * Copyright (c) 2023 lexoyo and Silex Labs foundation
5
+ *
6
+ * This program is free software: you can redistribute it and/or modify
7
+ * it under the terms of the GNU Affero General Public License as published by
8
+ * the Free Software Foundation, either version 3 of the License, or any later version.
9
+ *
10
+ * This program is distributed in the hope that it will be useful,
11
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
+ * GNU Affero General Public License for more details.
14
+ *
15
+ * You should have received a copy of the GNU Affero General Public License
16
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
17
+ */
18
+ Object.defineProperty(exports, "__esModule", { value: true });
19
+ exports.API_WEBSITE_META_WRITE = exports.API_WEBSITE_META_READ = exports.API_WEBSITE_ASSETS_WRITE = exports.API_WEBSITE_ASSETS_READ = exports.API_WEBSITE_LIST = exports.API_WEBSITE_DELETE = exports.API_WEBSITE_CREATE = exports.API_WEBSITE_WRITE = exports.API_WEBSITE_READ = exports.API_WEBSITE_PATH = exports.API_PUBLICATION_STATUS = exports.API_PUBLICATION_PUBLISH = exports.API_PUBLICATION_PATH = exports.API_CONNECTOR_LOGIN_CALLBACK = exports.API_CONNECTOR_SETTINGS = exports.API_CONNECTOR_LOGIN = exports.API_CONNECTOR_LOGOUT = exports.API_CONNECTOR_LIST = exports.API_CONNECTOR_USER = exports.API_CONNECTOR_PATH = exports.API_PATH = exports.CLIENT_CONFIG_FILE_NAME = exports.DEFAULT_LANGUAGE = exports.DEFAULT_CONNECTOR_ID = exports.DEFAULT_WEBSITE_ID = exports.WEBSITE_META_DATA_FILE = exports.WEBSITE_DATA_FILE = void 0;
20
+ /**
21
+ * @fileoverview define constants for Silex client and server
22
+ */
23
+ exports.WEBSITE_DATA_FILE = 'website.json';
24
+ exports.WEBSITE_META_DATA_FILE = 'meta.json';
25
+ exports.DEFAULT_WEBSITE_ID = 'default';
26
+ exports.DEFAULT_CONNECTOR_ID = '';
27
+ exports.DEFAULT_LANGUAGE = 'en';
28
+ exports.CLIENT_CONFIG_FILE_NAME = 'silex.js';
29
+ exports.API_PATH = '/api';
30
+ exports.API_CONNECTOR_PATH = '/connector';
31
+ exports.API_CONNECTOR_USER = '/user';
32
+ exports.API_CONNECTOR_LIST = '/';
33
+ exports.API_CONNECTOR_LOGOUT = '/logout';
34
+ exports.API_CONNECTOR_LOGIN = '/login';
35
+ exports.API_CONNECTOR_SETTINGS = '/settings';
36
+ exports.API_CONNECTOR_LOGIN_CALLBACK = '/login/callback';
37
+ exports.API_PUBLICATION_PATH = '/publication';
38
+ exports.API_PUBLICATION_PUBLISH = '/';
39
+ exports.API_PUBLICATION_STATUS = '/publication/status';
40
+ exports.API_WEBSITE_PATH = '/website';
41
+ exports.API_WEBSITE_READ = '/';
42
+ exports.API_WEBSITE_WRITE = '/';
43
+ exports.API_WEBSITE_CREATE = '/';
44
+ exports.API_WEBSITE_DELETE = '/';
45
+ exports.API_WEBSITE_LIST = '/';
46
+ exports.API_WEBSITE_ASSETS_READ = 'assets/:path';
47
+ exports.API_WEBSITE_ASSETS_WRITE = 'assets';
48
+ exports.API_WEBSITE_META_READ = '/meta';
49
+ exports.API_WEBSITE_META_WRITE = '/meta';
50
+ //# sourceMappingURL=constants.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/ts/constants.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH;;GAEG;AAEU,QAAA,iBAAiB,GAAG,cAAc,CAAA;AAClC,QAAA,sBAAsB,GAAG,WAAW,CAAA;AAEpC,QAAA,kBAAkB,GAAG,SAAS,CAAA;AAC9B,QAAA,oBAAoB,GAAG,EAAE,CAAA;AACzB,QAAA,gBAAgB,GAAG,IAAI,CAAA;AACvB,QAAA,uBAAuB,GAAG,UAAU,CAAA;AAEpC,QAAA,QAAQ,GAAG,MAAM,CAAA;AAEjB,QAAA,kBAAkB,GAAG,YAAY,CAAA;AACjC,QAAA,kBAAkB,GAAG,OAAO,CAAA;AAC5B,QAAA,kBAAkB,GAAG,GAAG,CAAA;AACxB,QAAA,oBAAoB,GAAG,SAAS,CAAA;AAChC,QAAA,mBAAmB,GAAG,QAAQ,CAAA;AAC9B,QAAA,sBAAsB,GAAG,WAAW,CAAA;AACpC,QAAA,4BAA4B,GAAG,iBAAiB,CAAA;AAEhD,QAAA,oBAAoB,GAAG,cAAc,CAAA;AACrC,QAAA,uBAAuB,GAAG,GAAG,CAAA;AAC7B,QAAA,sBAAsB,GAAG,qBAAqB,CAAA;AAE9C,QAAA,gBAAgB,GAAG,UAAU,CAAA;AAC7B,QAAA,gBAAgB,GAAG,GAAG,CAAA;AACtB,QAAA,iBAAiB,GAAG,GAAG,CAAA;AACvB,QAAA,kBAAkB,GAAG,GAAG,CAAA;AACxB,QAAA,kBAAkB,GAAG,GAAG,CAAA;AACxB,QAAA,gBAAgB,GAAG,GAAG,CAAA;AACtB,QAAA,uBAAuB,GAAG,cAAc,CAAA;AACxC,QAAA,wBAAwB,GAAG,QAAQ,CAAA;AACnC,QAAA,qBAAqB,GAAG,OAAO,CAAA;AAC/B,QAAA,sBAAsB,GAAG,OAAO,CAAA"}
@@ -0,0 +1,10 @@
1
+ export declare const EVENT_STARTUP_START = "silex:startup:start";
2
+ export declare const EVENT_STARTUP_END = "silex:startup:end";
3
+ export declare const EVENT_PUBLISH_START = "silex:publish:start";
4
+ export declare const EVENT_PUBLISH_DATA = "silex:publish:data";
5
+ export declare const EVENT_PUBLISH_END = "silex:publish:end";
6
+ export declare const EVENT_PUBLISH_ERROR = "silex:publish:error";
7
+ export declare const EVENT_PUBLISH_LOGIN_START = "silex:publish:login:start";
8
+ export declare const EVENT_PUBLISH_LOGIN_END = "silex:publish:login:end";
9
+ export declare const EVENT_ASSET_WRITE_END = "silex:asset:write:end";
10
+ export declare const EVENT_WRITE_END = "silex:write:end";
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ /*
3
+ * Silex website builder, free/libre no-code tool for makers.
4
+ * Copyright (c) 2023 lexoyo and Silex Labs foundation
5
+ *
6
+ * This program is free software: you can redistribute it and/or modify
7
+ * it under the terms of the GNU Affero General Public License as published by
8
+ * the Free Software Foundation, either version 3 of the License, or any later version.
9
+ *
10
+ * This program is distributed in the hope that it will be useful,
11
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
+ * GNU Affero General Public License for more details.
14
+ *
15
+ * You should have received a copy of the GNU Affero General Public License
16
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
17
+ */
18
+ Object.defineProperty(exports, "__esModule", { value: true });
19
+ exports.EVENT_WRITE_END = exports.EVENT_ASSET_WRITE_END = exports.EVENT_PUBLISH_LOGIN_END = exports.EVENT_PUBLISH_LOGIN_START = exports.EVENT_PUBLISH_ERROR = exports.EVENT_PUBLISH_END = exports.EVENT_PUBLISH_DATA = exports.EVENT_PUBLISH_START = exports.EVENT_STARTUP_END = exports.EVENT_STARTUP_START = void 0;
20
+ exports.EVENT_STARTUP_START = 'silex:startup:start';
21
+ exports.EVENT_STARTUP_END = 'silex:startup:end';
22
+ exports.EVENT_PUBLISH_START = 'silex:publish:start';
23
+ exports.EVENT_PUBLISH_DATA = 'silex:publish:data';
24
+ exports.EVENT_PUBLISH_END = 'silex:publish:end';
25
+ exports.EVENT_PUBLISH_ERROR = 'silex:publish:error';
26
+ exports.EVENT_PUBLISH_LOGIN_START = 'silex:publish:login:start';
27
+ exports.EVENT_PUBLISH_LOGIN_END = 'silex:publish:login:end';
28
+ exports.EVENT_ASSET_WRITE_END = 'silex:asset:write:end';
29
+ exports.EVENT_WRITE_END = 'silex:write:end';
30
+ //# sourceMappingURL=events.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/ts/events.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEU,QAAA,mBAAmB,GAAG,qBAAqB,CAAA;AAC3C,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACvC,QAAA,mBAAmB,GAAG,qBAAqB,CAAA;AAC3C,QAAA,kBAAkB,GAAG,oBAAoB,CAAA;AACzC,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACvC,QAAA,mBAAmB,GAAG,qBAAqB,CAAA;AAC3C,QAAA,yBAAyB,GAAG,2BAA2B,CAAA;AACvD,QAAA,uBAAuB,GAAG,yBAAyB,CAAA;AACnD,QAAA,qBAAqB,GAAG,uBAAuB,CAAA;AAC/C,QAAA,eAAe,GAAG,iBAAiB,CAAA"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AuthPlugin.js","sourceRoot":"","sources":["../../../../../src/ts/plugins/server/AuthPlugin.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAKY,KAAK,oBAAU,MAAM,EAAE,IAAI,GAAG,EAAE;IAC/C,iDAAiD;IACjD,qCAAqC;IACrC,uFAAuF;IACvF,aAAa;IACb,4DAA4D;IAC5D,yDAAyD;IACzD,6CAA6C;IAC7C,mDAAmD;IACnD,gBAAgB;IAChB,sBAAsB;IACtB,wGAAwG;IACxG,wDAAwD;IACxD,SAAS;IACT,QAAQ;IACR,qBAAqB;IACrB,MAAM;AACN,CAAC;AAjBD,4BAiBC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Cache.js","sourceRoot":"","sources":["../../../../../src/ts/plugins/server/Cache.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,SAAgB,OAAO,CAAE,GAAG,EAAE,GAAG,EAAE,IAAI;IACrC,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,4DAA4D,CAAC,CAAA;IACzF,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;IAC3B,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;IAChC,IAAI,EAAE,CAAA;AACR,CAAC;AALD,0BAKC;AAED,SAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI;IACtC,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,gCAAgC,CAAC,CAAA,CAAC,MAAM;IACpE,IAAI,EAAE,CAAA;AACR,CAAC;AAHD,8BAGC"}
@@ -0,0 +1,94 @@
1
+ /// <reference types="node" />
2
+ import { Client } from 'basic-ftp';
3
+ import { Readable } from 'stream';
4
+ import { ConnectorFile, ConnectorFileContent, StatusCallback, StorageConnector } from '../../server/connectors/connectors';
5
+ import { ConnectorType, ConnectorUser, WebsiteMeta, FileMeta, JobData, WebsiteId, WebsiteMetaFileContent, WebsiteData, ConnectorOptions } from '../../types';
6
+ import { ServerConfig } from '../../server/config';
7
+ /**
8
+ * @fileoverview FTP connector for Silex
9
+ * This is a connector for Silex, which allows to store the website on a FTP server
10
+ * and to publish the website on a FTP server
11
+ * FIXME: As a hosting connector, this connector should only store the password in the session and the rest in the website data
12
+ * to prevent publishing a site on the wrong server + multiple sites on 1 server
13
+ * FIXME: Allow reuse of FTP session between calls
14
+ */
15
+ export interface FtpSessionData {
16
+ host: string;
17
+ user: string;
18
+ pass: string;
19
+ port: number;
20
+ secure: boolean;
21
+ storageRootPath?: string;
22
+ publicationPath?: string;
23
+ websiteUrl?: string;
24
+ }
25
+ export interface FtpSession {
26
+ [ConnectorType.STORAGE]?: FtpSessionData;
27
+ [ConnectorType.HOSTING]?: FtpSessionData;
28
+ }
29
+ interface FtpOptions {
30
+ type: ConnectorType;
31
+ path?: string;
32
+ authorizeUrl?: string;
33
+ authorizePath?: string;
34
+ }
35
+ interface FtpOptionsWithDefaults {
36
+ type: ConnectorType;
37
+ path: string;
38
+ authorizeUrl: string;
39
+ authorizePath: string;
40
+ }
41
+ /**
42
+ * @class FtpConnector
43
+ * @implements {HostingConnector}
44
+ * @implements {StorageConnector}
45
+ */
46
+ export default class FtpConnector implements StorageConnector<FtpSession> {
47
+ connectorId: string;
48
+ displayName: string;
49
+ icon: string;
50
+ options: FtpOptionsWithDefaults;
51
+ connectorType: ConnectorType;
52
+ constructor(config: ServerConfig, opts: FtpOptions);
53
+ sessionData(session: FtpSession): FtpSessionData;
54
+ rootPath(session: FtpSession): string;
55
+ write(ftp: Client, path: string, content: ConnectorFileContent, progress?: (message: string) => void): Promise<string>;
56
+ read(ftp: Client, path: string): Promise<Readable>;
57
+ readdir(ftp: Client, path: string): Promise<FileMeta[]>;
58
+ mkdir(ftp: Client, path: string): Promise<void>;
59
+ rmdir(ftp: Client, path: string): Promise<void>;
60
+ unlink(ftp: Client, path: string): Promise<import("basic-ftp").FTPResponse>;
61
+ getClient({ host, user, pass, port, secure }: {
62
+ host: any;
63
+ user: any;
64
+ pass: any;
65
+ port: any;
66
+ secure: any;
67
+ }): Promise<Client>;
68
+ closeClient(ftp: Client): void;
69
+ getOptions(formData: object): ConnectorOptions;
70
+ getOAuthUrl(session: FtpSession): Promise<string | null>;
71
+ getLoginForm(session: FtpSession, redirectTo: string): Promise<string | null>;
72
+ getSettingsForm(session: FtpSession, redirectTo: string): Promise<string | null>;
73
+ setToken(session: FtpSession, token: object): Promise<void>;
74
+ logout(session: FtpSession): Promise<void>;
75
+ getUser(session: FtpSession): Promise<ConnectorUser>;
76
+ isLoggedIn(session: FtpSession): Promise<boolean>;
77
+ setWebsiteMeta(session: FtpSession, id: string, data: WebsiteMetaFileContent): Promise<void>;
78
+ getWebsiteMeta(session: FtpSession, id: WebsiteId): Promise<WebsiteMeta>;
79
+ /**
80
+ * Create necessary folders
81
+ * Assets and root folders
82
+ */
83
+ createWebsite(session: FtpSession): Promise<WebsiteId>;
84
+ listWebsites(session: FtpSession): Promise<WebsiteMeta[]>;
85
+ readWebsite(session: FtpSession, websiteId: string): Promise<WebsiteData | Readable>;
86
+ updateWebsite(session: FtpSession, websiteId: string, data: WebsiteData): Promise<void>;
87
+ deleteWebsite(session: FtpSession, websiteId: string): Promise<void>;
88
+ writeAssets(session: any, id: WebsiteId, files: ConnectorFile[], statusCbk?: StatusCallback): Promise<string[]>;
89
+ readAsset(session: FtpSession, id: string, path: string): Promise<ConnectorFileContent>;
90
+ deleteAssets(session: FtpSession, id: WebsiteId, paths: string[]): Promise<void>;
91
+ getUrl(session: FtpSession, id: WebsiteId): Promise<string>;
92
+ publish(session: FtpSession, id: string, files: ConnectorFile[]): Promise<JobData>;
93
+ }
94
+ export {};