@nosecone/sveltekit 1.0.0-beta.1 → 1.0.0-beta.11

package/README.md

@@ -18,40 +18,59 @@
 
 Protect your SvelteKit application with secure headers.
 
-## Installation
+- [npm package (`@nosecone/sveltekit`)](https://www.npmjs.com/package/@nosecone/sveltekit)
+- [GitHub source code (`nosecone-sveltekit/` in `arcjet/arcjet-js`)](https://github.com/arcjet/arcjet-js/tree/main/nosecone-sveltekit)
 
-```shell
-npm install -S @nosecone/sveltekit
+## What is this?
+
+This is our adapter to integrate Nosecone into SvelteKit.
+Nosecone makes it easy to add and configure security headers.
+This package exists so that we can provide the best possible experience to
+SvelteKit users.
+
+## When should I use this?
+
+You can use this package with or without Arcjet to protect your app if you are
+using SvelteKit.
+Use [`@nosecone/next`][github-nosecone-next] if you use Next.js and
+use [`nosecone`][github-nosecone] itself if you use a different framework.
+
+## Install
+
+This package is ESM only.
+Install with npm in Node.js:
+
+```sh
+npm install @nosecone/sveltekit
 ```
 
 ## Example
 
-Update your `svelte.config.js` file for `csp`:
+Configure `csp` from Nosecone in `svelte.config.js`:
 
 ```diff
-import adapter from "@sveltejs/adapter-auto";
-import { vitePreprocess } from "@sveltejs/vite-plugin-svelte";
-+ import { csp } from "@nosecone/sveltekit"
-
-/** @type {import('@sveltejs/kit').Config} */
-const config = {
-  // Consult https://kit.svelte.dev/docs/integrations#preprocessors
-  // for more information about preprocessors
-  preprocess: vitePreprocess(),
-
-  kit: {
-+   csp: csp(),
-    // adapter-auto only supports some environments, see https://kit.svelte.dev/docs/adapter-auto for a list.
-    // If your environment is not supported, or you settled on a specific environment, switch out the adapter.
-    // See https://kit.svelte.dev/docs/adapters for more information about adapters.
-    adapter: adapter(),
-  },
-};
-
-export default config;
++import { csp } from "@nosecone/sveltekit"
+ import adapter from "@sveltejs/adapter-auto";
+ import { vitePreprocess } from "@sveltejs/vite-plugin-svelte";
+
+ /** @type {import('@sveltejs/kit').Config} */
+ const config = {
+   kit: {
+     // adapter-auto only supports some environments, see https://kit.svelte.dev/docs/adapter-auto for a list.
+     // If your environment is not supported, or you settled on a specific environment, switch out the adapter.
+     // See https://kit.svelte.dev/docs/adapters for more information about adapters.
+     adapter: adapter(),
++    csp: csp(),
+   },
+   // Consult https://kit.svelte.dev/docs/integrations#preprocessors
+   // for more information about preprocessors
+   preprocess: vitePreprocess(),
+ };
+
+ export default config;
 ```
 
-Create a `src/hooks.server.ts` file with the contents:
+…then use `createHook` from Nosecone in a `src/hooks.server.ts` file:
 
 ```ts
 import { createHook } from "@nosecone/sveltekit";
@@ -65,6 +84,9 @@ export const handle = sequence(
 
 ## License
 
-Licensed under the [Apache License, Version 2.0][apache-license].
+[Apache License, Version 2.0][apache-license] © [Arcjet Labs, Inc.][arcjet]
 
 [apache-license]: http://www.apache.org/licenses/LICENSE-2.0
+[arcjet]: https://arcjet.com
+[github-nosecone-next]: https://github.com/arcjet/arcjet-js/tree/main/nosecone-next
+[github-nosecone]: https://github.com/arcjet/arcjet-js/tree/main/nosecone

package/index.d.ts

@@ -1,7 +1,10 @@
 import nosecone from "nosecone";
-import type { CspDirectives, NoseconeOptions } from "nosecone";
+import type { CspDirectives, Options } from "nosecone";
 import type { Handle, KitConfig } from "@sveltejs/kit";
-export { withVercelToolbar, type NoseconeOptions } from "nosecone";
+export { withVercelToolbar, type Options, type NoseconeOptions, } from "nosecone";
+/**
+ * Nosecone SvelteKit defaults.
+ */
 export declare const defaults: {
     readonly directives: {
         readonly scriptSrc: readonly ["'strict-dynamic'"];
@@ -70,17 +73,43 @@ export declare const defaults: {
     };
     readonly xXssProtection: true;
 };
+export { nosecone };
+/**
+ * Create security headers.
+ *
+ * @deprecated
+ *   Use the named export `nosecone` instead.
+ */
 export default nosecone;
 /**
  * Create a SvelteKit hook that sets secure headers on every request.
  *
- * @param options: Configuration to provide to Nosecone
- * @returns A SvelteKit hook that sets secure headers
+ * @param options
+ *   Configuration to provide to Nosecone.
+ * @returns
+ *   SvelteKit hook that sets secure headers.
  */
-export declare function createHook(options?: NoseconeOptions): Handle;
+export declare function createHook(options?: Options): Handle;
 type SvelteKitCsp = Exclude<KitConfig["csp"], undefined>;
+/**
+ * Content Security Policy configuration for SvelteKit.
+ */
 export type ContentSecurityPolicyConfig = {
-    mode?: SvelteKitCsp["mode"];
-    directives?: CspDirectives;
+    /**
+     * Mode of the `Content-Security-Policy` header.
+     */
+    mode?: SvelteKitCsp["mode"] | undefined;
+    /**
+     * Directives to use in the `Content-Security-Policy` header.
+     */
+    directives?: CspDirectives | undefined;
 };
-export declare function csp(options?: ContentSecurityPolicyConfig): SvelteKitCsp;
+/**
+ * Create a SvelteKit Content Security Policy configuration.
+ *
+ * @param options
+ *   Configuration.
+ * @returns
+ *   SvelteKit Content Security Policy configuration.
+ */
+export declare function csp(options?: ContentSecurityPolicyConfig | undefined): SvelteKitCsp;

package/index.js

@@ -1,6 +1,9 @@
 import nosecone, { defaults as defaults$1, CONTENT_SECURITY_POLICY_DIRECTIVES, NoseconeValidationError, QUOTED } from 'nosecone';
-export { default, withVercelToolbar } from 'nosecone';
+export { default, default as nosecone, withVercelToolbar } from 'nosecone';
 
+/**
+ * Nosecone SvelteKit defaults.
+ */
 const defaults = {
     ...defaults$1,
     directives: {
@@ -11,8 +14,10 @@ const defaults = {
 /**
  * Create a SvelteKit hook that sets secure headers on every request.
  *
- * @param options: Configuration to provide to Nosecone
- * @returns A SvelteKit hook that sets secure headers
+ * @param options
+ *   Configuration to provide to Nosecone.
+ * @returns
+ *   SvelteKit hook that sets secure headers.
  */
 function createHook(options = defaults) {
     return async ({ event, resolve }) => {
@@ -73,10 +78,18 @@ function directivesToSvelteKitConfig(directives) {
     }
     return sveltekitDirectives;
 }
-function csp(options = { mode: "auto" }) {
+/**
+ * Create a SvelteKit Content Security Policy configuration.
+ *
+ * @param options
+ *   Configuration.
+ * @returns
+ *   SvelteKit Content Security Policy configuration.
+ */
+function csp(options) {
     return {
-        mode: options.mode ? options.mode : "auto",
-        directives: directivesToSvelteKitConfig(options.directives ?? defaults.contentSecurityPolicy.directives),
+        mode: options?.mode ? options.mode : "auto",
+        directives: directivesToSvelteKitConfig(options?.directives ?? defaults.contentSecurityPolicy.directives) || {},
     };
 }
 

package/package.json

@@ -1,7 +1,25 @@
 {
   "name": "@nosecone/sveltekit",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.11",
   "description": "Protect your SvelteKit application with secure headers",
+  "keywords": [
+    "arcjet",
+    "coep",
+    "coep",
+    "content-security-policy",
+    "coop",
+    "corp",
+    "cross-origin-embedder-policy",
+    "cross-origin-opener-policy",
+    "cross-origin-resource-policy",
+    "csp",
+    "header",
+    "http",
+    "nosecone",
+    "protect",
+    "sveltekit",
+    "svelte"
+  ],
   "license": "Apache-2.0",
   "homepage": "https://arcjet.com",
   "repository": {
@@ -25,33 +43,34 @@
   "main": "./index.js",
   "types": "./index.d.ts",
   "files": [
-    "LICENSE",
-    "README.md",
-    "*.js",
-    "*.d.ts",
-    "!*.config.js"
+    "index.d.ts",
+    "index.js"
   ],
   "scripts": {
-    "prepublishOnly": "npm run build",
     "build": "rollup --config rollup.config.js",
     "lint": "eslint .",
-    "pretest": "npm run build",
-    "test": "node --test"
+    "prepublishOnly": "npm run build",
+    "test-api": "node --test",
+    "test-coverage": "node --experimental-test-coverage --test",
+    "test": "npm run build && npm run lint && npm run test-coverage"
   },
   "dependencies": {
-    "nosecone": "1.0.0-beta.1"
+    "nosecone": "1.0.0-beta.11"
   },
   "peerDependencies": {
     "@sveltejs/kit": ">=2"
   },
   "devDependencies": {
-    "@arcjet/eslint-config": "1.0.0-beta.1",
-    "@arcjet/rollup-config": "1.0.0-beta.1",
-    "@arcjet/tsconfig": "1.0.0-beta.1",
-    "@rollup/wasm-node": "4.30.1",
-    "@sveltejs/kit": "^2.15.2",
-    "@types/node": "18.18.0",
-    "typescript": "5.7.3"
+    "@arcjet/eslint-config": "1.0.0-beta.11",
+    "@arcjet/rollup-config": "1.0.0-beta.11",
+    "@rollup/wasm-node": "4.50.0",
+    "@sveltejs/kit": "2.37.0",
+    "@sveltejs/vite-plugin-svelte": "6.1.4",
+    "@types/node": "24.3.0",
+    "eslint": "9.34.0",
+    "svelte": "5.38.6",
+    "typescript": "5.9.2",
+    "vite": "7.1.4"
   },
   "publishConfig": {
     "access": "public",