@arkstack/http 0.16.4 → 0.16.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/http",
-  "version": "0.16.4",
+  "version": "0.16.6",
   "type": "module",
   "description": "HTTP module for Arkstack, providing framework-agnostic request and response primitives.",
   "homepage": "https://arkstack.toneflix.net/guide/http",
@@ -17,7 +17,8 @@
     "arkstack"
   ],
   "files": [
-    "dist"
+    "dist",
+    "stubs"
   ],
   "publishConfig": {
     "access": "public"
@@ -30,11 +31,11 @@
   "dependencies": {
     "clear-router": "^2.9.0",
     "dotenv": "^17.4.2",
-    "@arkstack/contract": "^0.16.4",
-    "@arkstack/common": "^0.16.4"
+    "@arkstack/contract": "^0.16.6",
+    "@arkstack/common": "^0.16.6"
   },
   "peerDependencies": {
-    "arkormx": "^2.10.1",
+    "arkormx": "^2.11.2",
     "kanun": "^1.2.0"
   },
   "peerDependenciesMeta": {

package/stubs/config/resources.ts.stub

@@ -0,0 +1,52 @@
+import type { ResoraConfig } from 'resora'
+
+/**
+ * Resora configuration, applied per request by the `resora()` middleware and at
+ * generation time by `make:resource`.
+ *
+ * The object is cast to `ResoraConfig` because it also carries arkstack
+ * passthrough fields (`localStubsDir` and the controller/model stub names) that
+ * resora accepts at runtime but doesn't surface in its narrower config type.
+ */
+export default (): ResoraConfig => {
+    return {
+        preferredCase: 'camel',
+        responseStructure: {
+            wrap: true,
+            rootKey: 'data',
+        },
+        paginatedExtras: ['meta', 'links'],
+        baseUrl: env('APP_URL', 'http://localhost'),
+        pageName: 'page',
+        paginatedLinks: {
+            first: 'first',
+            last: 'last',
+            prev: 'prev',
+            next: 'next',
+        },
+        paginatedMeta: {
+            to: 'to',
+            from: 'from',
+            links: 'links',
+            path: 'path',
+            total: 'total',
+            per_page: 'per_page',
+            last_page: 'last_page',
+            current_page: 'current_page',
+        },
+        cursorMeta: {
+            previous: 'previous',
+            next: 'next',
+        },
+        resourcesDir: 'src/app/http/resources',
+        localStubsDir: 'node_modules/@arkstack/driver-express/stubs',
+        stubs: {
+            resource: 'resource.stub',
+            collection: 'resource.collection.stub',
+            controller: 'controller.stub',
+            api: 'controller.api.stub',
+            model: 'controller.model.stub',
+            apiResource: 'controller.api.resource.stub',
+        },
+    } as ResoraConfig
+}

package/stubs/config/session.ts.stub

@@ -0,0 +1,86 @@
+import { Arkstack } from '@arkstack/contract'
+import { SessionConfig } from '@arkstack/http'
+import { Str } from '@h3ravel/support'
+import { join } from 'node:path'
+
+export default (): SessionConfig => {
+    return {
+        secret: env('SESSION_SECRET', env('APP_KEY', 'change-me')),
+
+        /**
+         * Session Driver
+         * 
+         * The default session driver that is utilized for incoming requests.
+         * 
+         * Supported: "file", "cookie", "database", 
+         * (WIP: "apc", "memcached", "redis", "dynamodb", "array")
+         */
+        driver: env('SESSION_DRIVER', 'file'),
+
+        /**
+         * Cookie Name
+         * 
+         * The name of the session cookie that is created by Arkstack.
+         */
+        cookie: env(
+            'SESSION_COOKIE',
+            Str.slug(env('APP_NAME', 'arkstack'), '_') + '_session'
+        ),
+
+        /**
+         * Session Time To Live
+         * 
+         * The number of minutes that the session is allowed to remain idle before 
+         * it expires.
+         */
+        ttl: env('SESSION_LIFETIME', 60 * 60 * 24 * 7),
+
+        /**
+         * HTTP Only Access
+         * 
+         * Prevent JavaScript from accessing the value of the cookie making it 
+         * only accessible through the HTTP protocol.
+         */
+        http_only: true,
+
+        /**
+         * HTTPS Only Access
+         * 
+         * This option ensures that cookies will only be sent back to the server 
+         * if the browser has a HTTPS connection if set to "true".
+         */
+        secure: env('NODE_ENV', 'development') === 'production',
+
+        /**
+         * Same-Site Cookies
+         * 
+         * Determines how cookies behave when cross-site requests take 
+         * place, and can be used to mitigate CSRF attacks.
+         * See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value
+         * 
+         * Supported: "Lax", "Strict", "None", undefined
+         */
+        same_site: 'Lax',
+
+        /**
+         * Session Cookie Path
+         * 
+         * Determines the path for which the cookie will be available. 
+         */
+        path: '/',
+        /**
+         * Datbase Table 
+         * 
+         * For the "database" session driver, this will determine the table to
+         * be used to store sessions.
+         */
+        table: env('SESSION_TABLE', 'sessions'),
+
+        /**
+         * Session Directory
+         * 
+         * For the "file" session driver, the session files are placed in this directory.
+         */
+        directory: env('SESSION_FILE_PATH', join(Arkstack.rootDir(), './storage/framework/sessions')),
+    }
+}