millas 0.2.12-beta → 0.2.12-beta-1

package/src/facades/Mail.js

@@ -1,40 +1,35 @@
 'use strict';
 
+const { createFacade } = require('./Facade');
+const { MailMessage, TemplateEngine, SmtpDriver, SendGridDriver, MailgunDriver, LogDriver, MailServiceProvider } = require('../core');
+
 /**
- * millas/facades/Mail
+ * Mail facade.
  *
- *   const { Mail, MailMessage } = require('millas/facades/Mail');
+ * @class
+ * @property {function(MailMessage|object): Promise<void>} send
+ * @property {function(MailMessage|object): Promise<void>} queue
+ * @property {function(string, string=): MailMessage}      to
+ * @property {function(object): void}                      swap
+ * @property {function(): void}                            restore
  *
- *   await Mail.to('alice@example.com')
- *     .subject('Welcome!')
- *     .html('<h1>Hi Alice</h1>')
- *     .send();
+ * — MailMessage builder (returned by Mail.to())
+ * @property {function(string, string=): MailMessage}           MailMessage.prototype.to
+ * @property {function(string, string=): MailMessage}           MailMessage.prototype.cc
+ * @property {function(string, string=): MailMessage}           MailMessage.prototype.bcc
+ * @property {function(string, string=): MailMessage}           MailMessage.prototype.from
+ * @property {function(string, string=): MailMessage}           MailMessage.prototype.replyTo
+ * @property {function(string): MailMessage}                    MailMessage.prototype.subject
+ * @property {function(string): MailMessage}                    MailMessage.prototype.html
+ * @property {function(string): MailMessage}                    MailMessage.prototype.text
+ * @property {function(string, object=): MailMessage}           MailMessage.prototype.view
+ * @property {function(string, string=, string=): MailMessage}  MailMessage.prototype.attach
+ * @property {function(number): MailMessage}                    MailMessage.prototype.priority
+ * @property {function(): Promise<void>}                        MailMessage.prototype.send
+ * @property {function(): Promise<void>}                        MailMessage.prototype.queue
  *
- *   // Template
- *   await Mail.to(user.email)
- *     .subject('Reset your password')
- *     .view('emails/reset', { token, user })
- *     .send();
+ * @see src/mail/Mail.js
  */
+class Mail extends createFacade('mail') {}
 
-const {
-  Mail,
-  MailMessage,
-  TemplateEngine,
-  SmtpDriver,
-  SendGridDriver,
-  MailgunDriver,
-  LogDriver,
-  MailServiceProvider,
-} = require('../index');
-
-module.exports = {
-  Mail,
-  MailMessage,
-  TemplateEngine,
-  SmtpDriver,
-  SendGridDriver,
-  MailgunDriver,
-  LogDriver,
-  MailServiceProvider,
-};
+module.exports = Mail

package/src/facades/Queue.js

@@ -1,23 +1,30 @@
 'use strict';
 
+const { createFacade } = require('./Facade');
+
 /**
- * millas/facades/Queue
- *
- *   const { Queue, Job, dispatch } = require('millas/facades/Queue');
- *
- *   class SendWelcomeEmail extends Job {
- *     async handle() {
- *       await Mail.to(this.data.email).subject('Welcome').send();
- *     }
- *   }
+ * Queue facade.
  *
- *   // Dispatch a job
- *   await dispatch(new SendWelcomeEmail({ email: user.email }));
+ * @class
+ * @property {function(Job): Promise<void>}          push
+ * @property {function(string=): Promise<number>}    size
+ * @property {function(string=): Promise<void>}      clear
+ * @property {function(function): void}              register
+ * @property {function(object): void}                swap
+ * @property {function(): void}                      restore
  *
- *   // With delay
- *   await dispatch(new SendWelcomeEmail({ email }), { delay: 60 });
+ * @see src/queue/Queue.js
  */
+class Queue extends createFacade('queue') {}
 
-const { Queue, Job, QueueWorker, dispatch, QueueServiceProvider } = require('../index');
+/**
+ * Shorthand for Queue.push(job).
+ *
+ * @param {Job} job
+ * @returns {Promise<void>}
+ */
+async function dispatch(job) {
+  return Queue.push(job);
+}
 
-module.exports = { Queue, Job, QueueWorker, dispatch, QueueServiceProvider };
+module.exports = Queue;

package/src/facades/Storage.js

@@ -1,17 +1,25 @@
 'use strict';
 
+const { createFacade } = require('./Facade');
+
 /**
- * millas/facades/Storage
+ * Storage facade.
  *
- *   const { Storage } = require('millas/facades/Storage');
+ * @class
+ * @property {function(string, Buffer|string, object=): Promise<void>}    put
+ * @property {function(string): Promise<Buffer|string>}                   get
+ * @property {function(string): Promise<boolean>}                         exists
+ * @property {function(string): Promise<void>}                            delete
+ * @property {function(string): Promise<object>}                          metadata
+ * @property {function(string): string}                                   url
+ * @property {function(string): string}                                   path
+ * @property {function(string, object, object=): void}                    stream
+ * @property {function(string): Storage}                                  disk
+ * @property {function(object): void}                                     swap
+ * @property {function(): void}                                           restore
  *
- *   await Storage.put('avatars/user-5.jpg', fileBuffer);
- *   const url  = await Storage.url('avatars/user-5.jpg');
- *   const data = await Storage.get('avatars/user-5.jpg');
- *   await Storage.delete('avatars/user-5.jpg');
- *   const exists = await Storage.exists('avatars/user-5.jpg');
+ * @see src/storage/Storage.js
  */
+class Storage extends createFacade('storage') {}
 
-const { Storage, LocalDriver, StorageServiceProvider } = require('../index');
-
-module.exports = { Storage, LocalDriver, StorageServiceProvider };
+module.exports = Storage;

package/src/facades/Url.js

@@ -0,0 +1,53 @@
+'use strict';
+
+const {createFacade} = require('./Facade');
+
+/**
+ * URL facade — Laravel-like URL generation.
+ *
+ * @class
+ *
+ * — Base
+ * @property {function(): string}                                                  base
+ *
+ * — URL generation
+ * @property {function(string, object=): string}                                   to
+ * @property {function(string, object=): string}                                   secure
+ * @property {function(string, object=): string}                                   relative
+ *
+ * — Named routes
+ * @property {function(string, object=, object=): string}                          route
+ *
+ * — Assets
+ * @property {function(string): string}                                            asset
+ * @property {function(string): string}                                            secureAsset
+ *
+ * — Current / previous request
+ * @property {function(): string|null}                                             current
+ * @property {function(): string|null}                                             currentPath
+ * @property {function(string=): string}                                           previous
+ *
+ * — Signed URLs
+ * @property {function(string, object=, number=): string}                          signedRoute
+ * @property {function(string, number=): string}                                   signedUrl
+ * @property {function(object): boolean}                                           hasValidSignature
+ *
+ * — Scheme control
+ * @property {function(boolean=): UrlGenerator}                                    forceHttps
+ * @property {function(string): UrlGenerator}                                      forceScheme
+ * @property {function(string): UrlGenerator}                                      useAssetOrigin
+ *
+ * — Introspection
+ * @property {function(string): boolean}                                           isValid
+ * @property {function(...string): boolean}                                        is
+ *
+ * — Testing
+ * @property {function(object): void}                                              swap
+ * @property {function(): void}                                                    restore
+ *
+ * @see src/http/UrlGenerator.js
+ */
+class URL extends createFacade('url') {
+}
+
+module.exports = URL;