@punks/cli 0.1.16 → 1.0.0

package/dist/skills/frameworks/elysia/elysiajs/plugins/bearer.md

@@ -0,0 +1,30 @@
+# Bearer
+Plugin for Elysia for retrieving the Bearer token.
+
+## Installation
+```bash
+bun add @elysiajs/bearer
+```
+
+## Basic Usage
+```typescript twoslash
+import { Elysia } from 'elysia'
+import { bearer } from '@elysiajs/bearer'
+
+const app = new Elysia()
+    .use(bearer())
+    .get('/sign', ({ bearer }) => bearer, {
+        beforeHandle({ bearer, set, status }) {
+            if (!bearer) {
+                set.headers[
+                    'WWW-Authenticate'
+                ] = `Bearer realm='sign', error="invalid_request"`
+
+                return status(400, 'Unauthorized')
+            }
+        }
+    })
+    .listen(3000)
+```
+
+This plugin is for retrieving a Bearer token specified in RFC6750

package/dist/skills/frameworks/elysia/elysiajs/plugins/cors.md

@@ -0,0 +1,141 @@
+# CORS
+
+Plugin for Elysia that adds support for customizing Cross-Origin Resource Sharing behavior.
+
+## Installation
+```bash
+bun add @elysiajs/cors
+```
+
+## Basic Usage
+```typescript twoslash
+import { Elysia } from 'elysia'
+import { cors } from '@elysiajs/cors'
+
+new Elysia().use(cors()).listen(3000)
+```
+
+This will set Elysia to accept requests from any origin.
+
+## Config
+
+Below is a config which is accepted by the plugin
+
+### origin
+
+@default `true`
+
+Indicates whether the response can be shared with the requesting code from the given origins.
+
+Value can be one of the following:
+
+- **string** - Name of origin which will directly assign to Access-Control-Allow-Origin header.
+- **boolean** - If set to true, Access-Control-Allow-Origin will be set to `*` (any origins)
+- **RegExp** - Pattern to match request's URL, allowed if matched.
+- **Function** - Custom logic to allow resource sharing, allow if `true` is returned.
+    - Expected to have the type of:
+    ```typescript
+    cors(context: Context) => boolean | void
+    ```
+- **Array<string | RegExp | Function>** - iterate through all cases above in order, allowed if any of the values are `true`.
+
+---
+
+### methods
+
+@default `*`
+
+Allowed methods for cross-origin requests by assign `Access-Control-Allow-Methods` header.
+
+Value can be one of the following:
+- **undefined | null | ''** - Ignore all methods.
+- **\*** - Allows all methods.
+- **string** - Expects either a single method or a comma-delimited string
+    - (eg: `'GET, PUT, POST'`)
+- **string[]** - Allow multiple HTTP methods.
+    - eg: `['GET', 'PUT', 'POST']`
+
+---
+
+### allowedHeaders
+
+@default `*`
+
+Allowed headers for an incoming request by assign `Access-Control-Allow-Headers` header.
+
+Value can be one of the following:
+- **string** - Expects either a single header or a comma-delimited string
+    - eg: `'Content-Type, Authorization'`.
+- **string[]** - Allow multiple HTTP headers.
+    - eg: `['Content-Type', 'Authorization']`
+
+---
+
+### exposeHeaders
+
+@default `*`
+
+Response CORS with specified headers by sssign Access-Control-Expose-Headers header.
+
+Value can be one of the following:
+- **string** - Expects either a single header or a comma-delimited string.
+    - eg: `'Content-Type, X-Powered-By'`.
+- **string[]** - Allow multiple HTTP headers.
+    - eg: `['Content-Type', 'X-Powered-By']`
+
+---
+
+### credentials
+
+@default `true`
+
+The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request's credentials mode Request.credentials is `include`.
+
+Credentials are cookies, authorization headers, or TLS client certificates by assign `Access-Control-Allow-Credentials` header.
+
+---
+
+### maxAge
+
+@default `5`
+
+Indicates how long the results of a preflight request that is the information contained in the `Access-Control-Allow-Methods` and `Access-Control-Allow-Headers` headers) can be cached.
+
+Assign `Access-Control-Max-Age` header.
+
+---
+
+### preflight
+
+The preflight request is a request sent to check if the CORS protocol is understood and if a server is aware of using specific methods and headers.
+
+Response with **OPTIONS** request with 3 HTTP request headers:
+- **Access-Control-Request-Method**
+- **Access-Control-Request-Headers**
+- **Origin**
+
+This config indicates if the server should respond to preflight requests.
+
+---
+
+## Pattern
+
+Below you can find the common patterns to use the plugin.
+
+## Allow CORS by top-level domain
+
+```typescript twoslash
+import { Elysia } from 'elysia'
+import { cors } from '@elysiajs/cors'
+
+const app = new Elysia()
+	.use(
+		cors({
+			origin: /.*\.saltyaom\.com$/
+		})
+	)
+	.get('/', () => 'Hi')
+	.listen(3000)
+```
+
+This will allow requests from top-level domains with `saltyaom.com`

package/dist/skills/frameworks/elysia/elysiajs/plugins/cron.md

@@ -0,0 +1,265 @@
+# Cron Plugin
+
+This plugin adds support for running cronjob to Elysia server.
+
+## Installation
+
+```bash
+bun add @elysiajs/cron
+```
+
+## Basic Usage
+```typescript twoslash
+import { Elysia } from 'elysia'
+import { cron } from '@elysiajs/cron'
+
+new Elysia()
+	.use(
+		cron({
+			name: 'heartbeat',
+			pattern: '*/10 * * * * *',
+			run() {
+				console.log('Heartbeat')
+			}
+		})
+	)
+	.listen(3000)
+```
+
+The above code will log `heartbeat` every 10 seconds.
+
+## Config
+Below is a config which is accepted by the plugin
+
+### cron
+
+Create a cronjob for the Elysia server.
+
+```
+cron(config: CronConfig, callback: (Instance['store']) => void): this
+```
+
+`CronConfig` accepts the parameters specified below:
+
+---
+
+### CronConfig.name
+
+Job name to register to `store`.
+
+This will register the cron instance to `store` with a specified name, which can be used to reference in later processes eg. stop the job.
+
+---
+
+### CronConfig.pattern
+
+Time to run the job as specified by cron syntax.
+
+```
+┌────────────── second (optional)
+│ ┌──────────── minute
+│ │ ┌────────── hour
+│ │ │ ┌──────── day of the month
+│ │ │ │ ┌────── month
+│ │ │ │ │ ┌──── day of week
+│ │ │ │ │ │
+* * * * * *
+```
+
+---
+
+### CronConfig.timezone
+Time zone in Europe/Stockholm format
+
+---
+
+### CronConfig.startAt
+Schedule start time for the job
+
+---
+
+### CronConfig.stopAt
+Schedule stop time for the job
+
+---
+
+### CronConfig.maxRuns
+Maximum number of executions
+
+---
+
+### CronConfig.catch
+Continue execution even if an unhandled error is thrown by a triggered function.
+
+### CronConfig.interval
+The minimum interval between executions, in seconds.
+
+---
+
+## CronConfig.Pattern
+Below you can find the common patterns to use the plugin.
+
+---
+
+## Pattern
+
+Below you can find the common patterns to use the plugin.
+
+## Stop cronjob
+
+You can stop cronjob manually by accessing the cronjob name registered to `store`.
+
+```typescript
+import { Elysia } from 'elysia'
+import { cron } from '@elysiajs/cron'
+
+const app = new Elysia()
+	.use(
+		cron({
+			name: 'heartbeat',
+			pattern: '*/1 * * * * *',
+			run() {
+				console.log('Heartbeat')
+			}
+		})
+	)
+	.get(
+		'/stop',
+		({
+			store: {
+				cron: { heartbeat }
+			}
+		}) => {
+			heartbeat.stop()
+
+			return 'Stop heartbeat'
+		}
+	)
+	.listen(3000)
+```
+
+---
+
+## Predefined patterns
+
+You can use predefined patterns from `@elysiajs/cron/schedule`
+
+```typescript
+import { Elysia } from 'elysia'
+import { cron, Patterns } from '@elysiajs/cron'
+
+const app = new Elysia()
+	.use(
+		cron({
+			name: 'heartbeat',
+			pattern: Patterns.everySecond(),
+			run() {
+				console.log('Heartbeat')
+			}
+		})
+	)
+	.get(
+		'/stop',
+		({
+			store: {
+				cron: { heartbeat }
+			}
+		}) => {
+			heartbeat.stop()
+
+			return 'Stop heartbeat'
+		}
+	)
+	.listen(3000)
+```
+
+### Functions
+
+| Function                                 | Description                                           |
+| ---------------------------------------- | ----------------------------------------------------- |
+| `.everySeconds(2)`                       | Run the task every 2 seconds                          |
+| `.everyMinutes(5)`                       | Run the task every 5 minutes                          |
+| `.everyHours(3)`                         | Run the task every 3 hours                            |
+| `.everyHoursAt(3, 15)`                   | Run the task every 3 hours at 15 minutes              |
+| `.everyDayAt('04:19')`                   | Run the task every day at 04:19                       |
+| `.everyWeekOn(Patterns.MONDAY, '19:30')` | Run the task every Monday at 19:30                    |
+| `.everyWeekdayAt('17:00')`               | Run the task every day from Monday to Friday at 17:00 |
+| `.everyWeekendAt('11:00')`               | Run the task on Saturday and Sunday at 11:00          |
+
+### Function aliases to constants
+
+| Function          | Constant                           |
+| ----------------- | ---------------------------------- |
+| `.everySecond()`  | EVERY_SECOND                       |
+| `.everyMinute()`  | EVERY_MINUTE                       |
+| `.hourly()`       | EVERY_HOUR                         |
+| `.daily()`        | EVERY_DAY_AT_MIDNIGHT              |
+| `.everyWeekday()` | EVERY_WEEKDAY                      |
+| `.everyWeekend()` | EVERY_WEEKEND                      |
+| `.weekly()`       | EVERY_WEEK                         |
+| `.monthly()`      | EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT |
+| `.everyQuarter()` | EVERY_QUARTER                      |
+| `.yearly()`       | EVERY_YEAR                         |
+
+### Constants
+
+| Constant                                 | Pattern              |
+| ---------------------------------------- | -------------------- |
+| `.EVERY_SECOND`                          | `* * * * * *`        |
+| `.EVERY_5_SECONDS`                       | `*/5 * * * * *`      |
+| `.EVERY_10_SECONDS`                      | `*/10 * * * * *`     |
+| `.EVERY_30_SECONDS`                      | `*/30 * * * * *`     |
+| `.EVERY_MINUTE`                          | `*/1 * * * *`        |
+| `.EVERY_5_MINUTES`                       | `0 */5 * * * *`      |
+| `.EVERY_10_MINUTES`                      | `0 */10 * * * *`     |
+| `.EVERY_30_MINUTES`                      | `0 */30 * * * *`     |
+| `.EVERY_HOUR`                            | `0 0-23/1 * * *`     |
+| `.EVERY_2_HOURS`                         | `0 0-23/2 * * *`     |
+| `.EVERY_3_HOURS`                         | `0 0-23/3 * * *`     |
+| `.EVERY_4_HOURS`                         | `0 0-23/4 * * *`     |
+| `.EVERY_5_HOURS`                         | `0 0-23/5 * * *`     |
+| `.EVERY_6_HOURS`                         | `0 0-23/6 * * *`     |
+| `.EVERY_7_HOURS`                         | `0 0-23/7 * * *`     |
+| `.EVERY_8_HOURS`                         | `0 0-23/8 * * *`     |
+| `.EVERY_9_HOURS`                         | `0 0-23/9 * * *`     |
+| `.EVERY_10_HOURS`                        | `0 0-23/10 * * *`    |
+| `.EVERY_11_HOURS`                        | `0 0-23/11 * * *`    |
+| `.EVERY_12_HOURS`                        | `0 0-23/12 * * *`    |
+| `.EVERY_DAY_AT_1AM`                      | `0 01 * * *`         |
+| `.EVERY_DAY_AT_2AM`                      | `0 02 * * *`         |
+| `.EVERY_DAY_AT_3AM`                      | `0 03 * * *`         |
+| `.EVERY_DAY_AT_4AM`                      | `0 04 * * *`         |
+| `.EVERY_DAY_AT_5AM`                      | `0 05 * * *`         |
+| `.EVERY_DAY_AT_6AM`                      | `0 06 * * *`         |
+| `.EVERY_DAY_AT_7AM`                      | `0 07 * * *`         |
+| `.EVERY_DAY_AT_8AM`                      | `0 08 * * *`         |
+| `.EVERY_DAY_AT_9AM`                      | `0 09 * * *`         |
+| `.EVERY_DAY_AT_10AM`                     | `0 10 * * *`         |
+| `.EVERY_DAY_AT_11AM`                     | `0 11 * * *`         |
+| `.EVERY_DAY_AT_NOON`                     | `0 12 * * *`         |
+| `.EVERY_DAY_AT_1PM`                      | `0 13 * * *`         |
+| `.EVERY_DAY_AT_2PM`                      | `0 14 * * *`         |
+| `.EVERY_DAY_AT_3PM`                      | `0 15 * * *`         |
+| `.EVERY_DAY_AT_4PM`                      | `0 16 * * *`         |
+| `.EVERY_DAY_AT_5PM`                      | `0 17 * * *`         |
+| `.EVERY_DAY_AT_6PM`                      | `0 18 * * *`         |
+| `.EVERY_DAY_AT_7PM`                      | `0 19 * * *`         |
+| `.EVERY_DAY_AT_8PM`                      | `0 20 * * *`         |
+| `.EVERY_DAY_AT_9PM`                      | `0 21 * * *`         |
+| `.EVERY_DAY_AT_10PM`                     | `0 22 * * *`         |
+| `.EVERY_DAY_AT_11PM`                     | `0 23 * * *`         |
+| `.EVERY_DAY_AT_MIDNIGHT`                 | `0 0 * * *`          |
+| `.EVERY_WEEK`                            | `0 0 * * 0`          |
+| `.EVERY_WEEKDAY`                         | `0 0 * * 1-5`        |
+| `.EVERY_WEEKEND`                         | `0 0 * * 6,0`        |
+| `.EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT`    | `0 0 1 * *`          |
+| `.EVERY_1ST_DAY_OF_MONTH_AT_NOON`        | `0 12 1 * *`         |
+| `.EVERY_2ND_HOUR`                        | `0 */2 * * *`        |
+| `.EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM`  | `0 1-23/2 * * *`     |
+| `.EVERY_2ND_MONTH`                       | `0 0 1 */2 *`        |
+| `.EVERY_QUARTER`                         | `0 0 1 */3 *`        |
+| `.EVERY_6_MONTHS`                        | `0 0 1 */6 *`        |
+| `.EVERY_YEAR`                            | `0 0 1 1 *`          |
+| `.EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM`  | `0 */30 9-17 * * *`  |
+| `.EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM`  | `0 */30 9-18 * * *`  |
+| `.EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM` | `0 */30 10-19 * * *` |

package/dist/skills/frameworks/elysia/elysiajs/plugins/graphql-apollo.md

@@ -0,0 +1,90 @@
+# GraphQL Apollo
+
+Plugin for Elysia to use GraphQL Apollo.
+
+## Installation
+```bash
+bun add graphql @elysiajs/apollo @apollo/server
+```
+
+## Basic Usage
+
+```typescript
+import { Elysia } from 'elysia'
+import { apollo, gql } from '@elysiajs/apollo'
+
+const app = new Elysia()
+	.use(
+		apollo({
+			typeDefs: gql`
+				type Book {
+					title: String
+					author: String
+				}
+
+				type Query {
+					books: [Book]
+				}
+			`,
+			resolvers: {
+				Query: {
+					books: () => {
+						return [
+							{
+								title: 'Elysia',
+								author: 'saltyAom'
+							}
+						]
+					}
+				}
+			}
+		})
+	)
+	.listen(3000)
+```
+
+Accessing `/graphql` should show Apollo GraphQL playground work with.
+
+## Context
+
+Because Elysia is based on Web Standard Request and Response which is different from Node's `HttpRequest` and `HttpResponse` that Express uses, results in `req, res` being undefined in context.
+
+Because of this, Elysia replaces both with `context` like route parameters.
+
+```typescript
+const app = new Elysia()
+	.use(
+		apollo({
+			typeDefs,
+			resolvers,
+			context: async ({ request }) => {
+				const authorization = request.headers.get('Authorization')
+
+				return {
+					authorization
+				}
+			}
+		})
+	)
+	.listen(3000)
+```
+
+## Config
+
+This plugin extends Apollo's [ServerRegistration](https://www.apollographql.com/docs/apollo-server/api/apollo-server/#options) (which is `ApolloServer`'s' constructor parameter).
+
+Below are the extended parameters for configuring Apollo Server with Elysia.
+
+### path
+
+@default `"/graphql"`
+
+Path to expose Apollo Server.
+
+---
+
+### enablePlayground
+
+@default `process.env.ENV !== 'production'`
+
+Determine whether should Apollo should provide Apollo Playground.

package/dist/skills/frameworks/elysia/elysiajs/plugins/graphql-yoga.md

@@ -0,0 +1,87 @@
+# GraphQL Yoga
+
+This plugin integrates GraphQL yoga with Elysia
+
+## Installation
+```bash
+bun add @elysiajs/graphql-yoga
+```
+
+## Basic Usage
+```typescript
+import { Elysia } from 'elysia'
+import { yoga } from '@elysiajs/graphql-yoga'
+
+const app = new Elysia()
+	.use(
+		yoga({
+			typeDefs: /* GraphQL */ `
+				type Query {
+					hi: String
+				}
+			`,
+			resolvers: {
+				Query: {
+					hi: () => 'Hello from Elysia'
+				}
+			}
+		})
+	)
+	.listen(3000)
+```
+
+Accessing `/graphql` in the browser (GET request) would show you a GraphiQL instance for the GraphQL-enabled Elysia server.
+
+optional: you can install a custom version of optional peer dependencies as well:
+
+```bash
+bun add graphql graphql-yoga
+```
+
+## Resolver
+
+Elysia uses Mobius to infer type from **typeDefs** field automatically, allowing you to get full type-safety and auto-complete when typing **resolver** types.
+
+## Context
+
+You can add custom context to the resolver function by adding **context**
+
+```ts
+import { Elysia } from 'elysia'
+import { yoga } from '@elysiajs/graphql-yoga'
+
+const app = new Elysia()
+	.use(
+		yoga({
+			typeDefs: /* GraphQL */ `
+				type Query {
+					hi: String
+				}
+			`,
+			context: {
+				name: 'Mobius'
+			},
+			// If context is a function on this doesn't present
+			// for some reason it won't infer context type
+			useContext(_) {},
+			resolvers: {
+				Query: {
+					hi: async (parent, args, context) => context.name
+				}
+			}
+		})
+	)
+	.listen(3000)
+```
+
+## Config
+
+This plugin extends [GraphQL Yoga's createYoga options, please refer to the GraphQL Yoga documentation](https://the-guild.dev/graphql/yoga-server/docs) with inlining `schema` config to root.
+
+Below is a config which is accepted by the plugin
+
+### path
+
+@default `/graphql`
+
+Endpoint to expose GraphQL handler