@flexacms/sveltekit 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ivan Mercedes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,49 @@
-# Temporary Holding Version
+# @flexacms/sveltekit
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Flexa](https://github.com/flexacms) for SvelteKit: a server hook that puts a client on `event.locals.flexa`, available in every server `load` function and form action.
+
+```bash
+npm install @flexacms/sveltekit
+```
+
+```ts
+// src/hooks.server.ts
+import { env } from '$env/dynamic/private';
+import { createFlexaHandle } from '@flexacms/sveltekit';
+
+export const handle = createFlexaHandle({
+    url: env.FLEXA_URL,
+    apiKey: env.FLEXA_API_KEY,
+});
+```
+
+```ts
+// src/app.d.ts
+import type { FlexaClient } from '@flexacms/sveltekit';
+import type { FlexaSchema } from './flexa'; // optional: npx @flexacms/cli generate
+
+declare global {
+    namespace App {
+        interface Locals {
+            flexa: FlexaClient<FlexaSchema>;
+        }
+    }
+}
+
+export {};
+```
+
+```ts
+// src/routes/blog/[slug]/+page.server.ts
+import { error } from '@sveltejs/kit';
+
+export async function load({ locals, params }) {
+    const post = await locals.flexa.entity('posts').find(params.slug);
+
+    if (!post) error(404);
+
+    return { post };
+}
+```
+
+The client uses SvelteKit's `event.fetch`. Combine the hook with others using `sequence()` from `@sveltejs/kit/hooks`.

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import { ContentSchema, FlexaClientOptions } from '@flexacms/client';
+export * from '@flexacms/client';
+
+/**
+ * The parts of SvelteKit's `handle` hook this package uses. Declared here so
+ * the package does not depend on a specific SvelteKit version.
+ */
+interface HandleInput<TEvent extends {
+    locals: object;
+    fetch: typeof fetch;
+}> {
+    event: TEvent;
+    resolve: (event: TEvent) => Response | Promise<Response>;
+}
+/**
+ * A server `handle` hook that puts a Flexa client on `event.locals.flexa`, so
+ * every `load` function and form action can read content with the private key.
+ *
+ *     // src/hooks.server.ts
+ *     import { env } from '$env/dynamic/private';
+ *     export const handle = createFlexaHandle({ url: env.FLEXA_URL, apiKey: env.FLEXA_API_KEY });
+ *
+ * Combine it with other hooks using `sequence()` from `@sveltejs/kit/hooks`.
+ * `url` and `apiKey` fall back to the FLEXA_URL and FLEXA_API_KEY environment variables.
+ */
+declare function createFlexaHandle<TSchema extends object = ContentSchema>(options?: Partial<FlexaClientOptions>): <TEvent extends {
+    locals: object;
+    fetch: typeof fetch;
+}>({ event, resolve }: HandleInput<TEvent>) => Promise<Response>;
+
+export { createFlexaHandle };

package/dist/index.js

@@ -0,0 +1,25 @@
+// src/index.ts
+import { createClient } from "@flexacms/client";
+export * from "@flexacms/client";
+function createFlexaHandle(options = {}) {
+  const url = options.url ?? process.env.FLEXA_URL;
+  const apiKey = options.apiKey ?? process.env.FLEXA_API_KEY;
+  if (!url || !apiKey) {
+    throw new Error(
+      'Flexa: pass "url" and "apiKey" (e.g. from $env/dynamic/private) or set FLEXA_URL and FLEXA_API_KEY.'
+    );
+  }
+  return async function handle({ event, resolve }) {
+    event.locals.flexa = createClient({
+      ...options,
+      url,
+      apiKey,
+      fetch: options.fetch ?? event.fetch
+    });
+    return resolve(event);
+  };
+}
+export {
+  createFlexaHandle
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { createClient } from '@flexacms/client';\nimport type {\n    ContentSchema,\n    FlexaClient,\n    FlexaClientOptions,\n} from '@flexacms/client';\n\nexport * from '@flexacms/client';\n\n/**\n * The parts of SvelteKit's `handle` hook this package uses. Declared here so\n * the package does not depend on a specific SvelteKit version.\n */\ninterface HandleInput<TEvent extends { locals: object; fetch: typeof fetch }> {\n    event: TEvent;\n    resolve: (event: TEvent) => Response | Promise<Response>;\n}\n\n/**\n * A server `handle` hook that puts a Flexa client on `event.locals.flexa`, so\n * every `load` function and form action can read content with the private key.\n *\n *     // src/hooks.server.ts\n *     import { env } from '$env/dynamic/private';\n *     export const handle = createFlexaHandle({ url: env.FLEXA_URL, apiKey: env.FLEXA_API_KEY });\n *\n * Combine it with other hooks using `sequence()` from `@sveltejs/kit/hooks`.\n * `url` and `apiKey` fall back to the FLEXA_URL and FLEXA_API_KEY environment variables.\n */\nexport function createFlexaHandle<TSchema extends object = ContentSchema>(\n    options: Partial<FlexaClientOptions> = {},\n) {\n    const url = options.url ?? process.env.FLEXA_URL;\n    const apiKey = options.apiKey ?? process.env.FLEXA_API_KEY;\n\n    if (!url || !apiKey) {\n        throw new Error(\n            'Flexa: pass \"url\" and \"apiKey\" (e.g. from $env/dynamic/private) or set FLEXA_URL and FLEXA_API_KEY.',\n        );\n    }\n\n    return async function handle<\n        TEvent extends { locals: object; fetch: typeof fetch },\n    >({ event, resolve }: HandleInput<TEvent>) {\n        (event.locals as { flexa?: FlexaClient<TSchema> }).flexa =\n            createClient<TSchema>({\n                ...options,\n                url,\n                apiKey,\n                fetch: options.fetch ?? event.fetch,\n            });\n\n        return resolve(event);\n    };\n}\n"],"mappings":";AAAA,SAAS,oBAAoB;AAO7B,cAAc;AAsBP,SAAS,kBACZ,UAAuC,CAAC,GAC1C;AACE,QAAM,MAAM,QAAQ,OAAO,QAAQ,IAAI;AACvC,QAAM,SAAS,QAAQ,UAAU,QAAQ,IAAI;AAE7C,MAAI,CAAC,OAAO,CAAC,QAAQ;AACjB,UAAM,IAAI;AAAA,MACN;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO,eAAe,OAEpB,EAAE,OAAO,QAAQ,GAAwB;AACvC,IAAC,MAAM,OAA4C,QAC/C,aAAsB;AAAA,MAClB,GAAG;AAAA,MACH;AAAA,MACA;AAAA,MACA,OAAO,QAAQ,SAAS,MAAM;AAAA,IAClC,CAAC;AAEL,WAAO,QAAQ,KAAK;AAAA,EACxB;AACJ;","names":[]}

package/package.json

@@ -1,6 +1,50 @@
 {
-  "name": "@flexacms/sveltekit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+    "name": "@flexacms/sveltekit",
+    "version": "0.1.0",
+    "description": "SvelteKit integration for the Flexa headless CMS: a server hook that puts a Flexa client on event.locals.",
+    "keywords": [
+        "cms",
+        "flexa",
+        "headless",
+        "svelte",
+        "sveltekit"
+    ],
+    "homepage": "https://github.com/flexacms/sdk/tree/main/packages/sveltekit#readme",
+    "bugs": {
+        "url": "https://github.com/flexacms/sdk/issues"
+    },
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/flexacms/sdk.git",
+        "directory": "packages/sveltekit"
+    },
+    "files": [
+        "dist",
+        "README.md",
+        "LICENSE"
+    ],
+    "type": "module",
+    "sideEffects": false,
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        }
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "build": "tsup",
+        "typecheck": "tsc -p tsconfig.json"
+    },
+    "dependencies": {
+        "@flexacms/client": "^0.1.0"
+    },
+    "peerDependencies": {
+        "@sveltejs/kit": ">=2.0.0"
+    }
+}