-
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
12 changed files
with
231 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
# Stacks SMS | ||
|
||
Stacks SMS is driver system for sending SMS messages. | ||
|
||
## ☘️ Features | ||
|
||
- 📦 Send SMS | ||
|
||
## 🤖 Usage | ||
|
||
```bash | ||
bun install -d @stacksjs/sms | ||
``` | ||
|
||
You may now use it in your project: | ||
|
||
```ts | ||
import * as sms from '@stacksjs/sms' | ||
|
||
/* Then choose a driver. E.g for twilio */ | ||
const notification = sms.twilio | ||
|
||
notification.send(SMSOptions) | ||
|
||
interface SMSOptions { | ||
to: string | ||
content: string | ||
from?: string | ||
attachments?: AttachmentOptions[] | ||
id?: string | ||
} | ||
``` | ||
|
||
### Drivers | ||
|
||
Drivers are configured with the following environment variables: | ||
|
||
#### Twilio | ||
|
||
```bash | ||
TWILIO_ACCOUNT_SID=ACtest | ||
TWILIO_AUTH_TOKEN=testtoken | ||
TWILIO_FROM_NUMBER=+112345 | ||
TWILIO_TO_NUMBER=+145678 | ||
``` | ||
|
||
#### Nexmo | ||
|
||
```bash | ||
VONAGE_API_KEY=VN123 | ||
VONAGE_API_SECRET=testkey | ||
VONAGE_FROM_NUMBER=+112345 | ||
``` | ||
|
||
#### Gupshup | ||
|
||
```bash | ||
GUPSHUP_USER_ID=GU123 | ||
GUPSHUP_PASSWORD=password | ||
``` | ||
|
||
#### Plivo | ||
|
||
```bash | ||
PLIVO_ACCOUNT_ID=PA123 | ||
PLIVO_AUTH_TOKEN=testtoken | ||
PLIVO_FROM_NUMBER=+112345 | ||
``` | ||
|
||
#### SMS77 | ||
|
||
```bash | ||
SMS77_API_KEY=SA123 | ||
[email protected] | ||
``` | ||
|
||
#### SNS | ||
|
||
```bash | ||
SMS77_API_KEY=SA123 | ||
[email protected] | ||
``` | ||
|
||
#### Telnyx | ||
|
||
```bash | ||
TELNYX_API_KEY=TA123 | ||
TELNYX_MESSAGE_PROFILE_ID=testprofileid | ||
[email protected] | ||
``` | ||
|
||
#### Termii | ||
|
||
```bash | ||
TERMII_API_KEY=TermA123 | ||
[email protected] | ||
``` | ||
|
||
Learn more in the docs. | ||
|
||
## 🧪 Testing | ||
|
||
```bash | ||
bun test | ||
``` | ||
|
||
## 📈 Changelog | ||
|
||
Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently. | ||
|
||
## 🚜 Contributing | ||
|
||
Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details. | ||
|
||
## 🏝 Community | ||
|
||
For help, discussion about best practices, or any other conversation that would benefit from being searchable: | ||
|
||
[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions) | ||
|
||
For casual chit-chat with others using this package: | ||
|
||
[Join the Stacks Discord Server](https://discord.gg/stacksjs) | ||
|
||
## 🙏🏼 Credits | ||
|
||
Many thanks to the following core technologies & people who have contributed to this package: | ||
|
||
- [Chris Breuer](https://github.com/chrisbbreuer) | ||
- [All Contributors](../../contributors) | ||
|
||
## 📄 License | ||
|
||
The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information. | ||
|
||
Made with 💙 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
import { dts } from 'bun-plugin-dtsx' | ||
import { intro, outro } from '../build/src' | ||
|
||
const { startTime } = await intro({ | ||
dir: import.meta.dir, | ||
}) | ||
|
||
const result = await Bun.build({ | ||
entrypoints: ['./src/index.ts'], | ||
outdir: './dist', | ||
format: 'esm', | ||
target: 'bun', | ||
// sourcemap: 'linked', | ||
minify: true, | ||
plugins: [ | ||
dts({ | ||
root: './src', | ||
outdir: './dist', | ||
}), | ||
], | ||
}) | ||
|
||
await outro({ | ||
dir: import.meta.dir, | ||
startTime, | ||
result, | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
{ | ||
"name": "@stacksjs/cron", | ||
"type": "module", | ||
"version": "0.68.2", | ||
"description": "The Stacks cron.", | ||
"author": "Chris Breuer", | ||
"contributors": ["Chris Breuer <[email protected]>"], | ||
"license": "MIT", | ||
"funding": "https://github.com/sponsors/chrisbbreuer", | ||
"homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/cron#readme", | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/stacksjs/stacks.git", | ||
"directory": "./storage/framework/core/cron" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/stacksjs/stacks/issues" | ||
}, | ||
"keywords": ["cron", "croner", "jobs", "bun", "stacks"], | ||
"exports": { | ||
".": { | ||
"import": "./dist/index.js" | ||
}, | ||
"./*": { | ||
"import": "./dist/*" | ||
} | ||
}, | ||
"module": "dist/index.js", | ||
"types": "dist/index.d.ts", | ||
"files": ["README.md", "dist"], | ||
"scripts": { | ||
"build": "bun build.ts", | ||
"typecheck": "bun tsc --noEmit", | ||
"prepublishOnly": "bun run build" | ||
}, | ||
"devDependencies": { | ||
"@stacksjs/development": "workspace:*", | ||
"croner": "^9.0.0" | ||
} | ||
} |
2 changes: 2 additions & 0 deletions
2
storage/framework/core/scheduler/src/cron.ts → storage/framework/core/cron/src/index.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,3 @@ | ||
export * from './types' | ||
|
||
export { Cron, CronDate, CronPattern, scheduledJobs } from 'croner' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import type { CatchCallbackFn, CronOptions, ProtectCallbackFn } from 'croner' | ||
|
||
export type { | ||
CatchCallbackFn, | ||
CronOptions, | ||
ProtectCallbackFn, | ||
} | ||
|
||
export type IntRange<Min extends number, Max extends number> = number extends Min | Max | ||
? never | ||
: number | [Min | number, Max | number] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import { describe, expect, it } from 'bun:test' | ||
|
||
describe('@stacksjs/cron', () => { | ||
it('should pass', () => { | ||
expect(true).toBe(true) | ||
}) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"extends": "../tsconfig.build.json" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters