@flexacms/astro 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,43 @@
-# Temporary Holding Version
+# @flexacms/astro
 
-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.
+Load [Flexa](https://github.com/flexacms) content into Astro content collections (Astro 5+ content layer).
+
+```bash
+npm install @flexacms/astro
+```
+
+```ts
+// src/content.config.ts
+import { defineCollection } from 'astro:content';
+import { flexaLoader } from '@flexacms/astro';
+
+const posts = defineCollection({
+    loader: flexaLoader({
+        entity: 'posts',
+        url: import.meta.env.FLEXA_URL,
+        apiKey: import.meta.env.FLEXA_API_KEY,
+    }),
+});
+
+export const collections = { posts };
+```
+
+```astro
+---
+import { getCollection } from 'astro:content';
+
+const posts = await getCollection('posts');
+---
+{posts.map((post) => <a href={`/blog/${post.id}`}>{post.data.title}</a>)}
+```
+
+Each entry is stored with its slug as id (or its numeric id when it has no slug) and the full API entry as `data`. By default only published entries are loaded.
+
+| Option           | Default                       |                                                               |
+| ---------------- | ----------------------------- | ------------------------------------------------------------- |
+| `entity`         | —                             | Entity slug                                                   |
+| `query`          | `{ status: 'published' }`     | `status`, `search`, `category`, `perPage`, `includeRelations` |
+| `id`             | slug, then id                 | `(entry) => string`                                           |
+| `url` / `apiKey` | `FLEXA_URL` / `FLEXA_API_KEY` |                                                               |
+
+Add a `schema` to `defineCollection` to validate or reshape `data` with Zod.

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+import { FlexaClientOptions, ListParams, Entry } from '@flexacms/client';
+export * from '@flexacms/client';
+
+/**
+ * The parts of Astro's loader context this loader uses. Declared here so the
+ * package does not depend on a specific Astro version.
+ */
+interface FlexaLoaderContext {
+    store: {
+        set(entry: {
+            id: string;
+            data: Record<string, unknown>;
+            digest?: string | number;
+        }): boolean;
+        clear(): void;
+    };
+    logger: {
+        info: (message: string) => void;
+    };
+    parseData: <TData extends Record<string, unknown>>(props: {
+        id: string;
+        data: TData;
+    }) => Promise<TData>;
+    generateDigest: (data: Record<string, unknown> | string) => string;
+}
+interface FlexaLoaderOptions extends Partial<FlexaClientOptions> {
+    /** Entity slug, e.g. `posts`. */
+    entity: string;
+    /** Filters for the entries to load. Defaults to published entries only. */
+    query?: Omit<ListParams, 'page'>;
+    /** Collection id of an entry. Defaults to its slug, or its id when it has none. */
+    id?: (entry: Entry) => string;
+}
+interface FlexaLoader {
+    name: string;
+    load(context: FlexaLoaderContext): Promise<void>;
+}
+/**
+ * Load the entries of a Flexa entity into an Astro content collection.
+ *
+ *     // src/content.config.ts
+ *     const posts = defineCollection({
+ *         loader: flexaLoader({
+ *             entity: 'posts',
+ *             url: import.meta.env.FLEXA_URL,
+ *             apiKey: import.meta.env.FLEXA_API_KEY,
+ *         }),
+ *     });
+ *
+ * `url` and `apiKey` fall back to the FLEXA_URL and FLEXA_API_KEY environment variables.
+ */
+declare function flexaLoader(options: FlexaLoaderOptions): FlexaLoader;
+
+export { type FlexaLoader, type FlexaLoaderContext, type FlexaLoaderOptions, flexaLoader };

package/dist/index.js

@@ -0,0 +1,50 @@
+// src/index.ts
+import { createClient } from "@flexacms/client";
+export * from "@flexacms/client";
+function flexaLoader(options) {
+  const {
+    entity,
+    query = { status: "published" },
+    id = (entry) => entry.slug ?? String(entry.id),
+    ...clientOptions
+  } = options;
+  return {
+    name: "flexa-loader",
+    async load({ store, logger, parseData, generateDigest }) {
+      const url = clientOptions.url ?? process.env.FLEXA_URL;
+      const apiKey = clientOptions.apiKey ?? process.env.FLEXA_API_KEY;
+      if (!url || !apiKey) {
+        throw new Error(
+          `Flexa loader "${entity}": set FLEXA_URL and FLEXA_API_KEY, or pass "url" and "apiKey".`
+        );
+      }
+      const entries = await createClient({
+        ...clientOptions,
+        url,
+        apiKey
+      }).entity(entity).all(query);
+      store.clear();
+      for (const entry of entries) {
+        const entryId = id(entry);
+        const data = await parseData({
+          id: entryId,
+          data: entry
+        });
+        store.set({
+          id: entryId,
+          data,
+          digest: generateDigest(
+            entry.updated_at ?? JSON.stringify(entry)
+          )
+        });
+      }
+      logger.info(
+        `Loaded ${entries.length} ${entries.length === 1 ? "entry" : "entries"} from Flexa "${entity}".`
+      );
+    }
+  };
+}
+export {
+  flexaLoader
+};
+//# 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 { Entry, FlexaClientOptions, ListParams } from '@flexacms/client';\n\nexport * from '@flexacms/client';\n\n/**\n * The parts of Astro's loader context this loader uses. Declared here so the\n * package does not depend on a specific Astro version.\n */\nexport interface FlexaLoaderContext {\n    store: {\n        set(entry: {\n            id: string;\n            data: Record<string, unknown>;\n            digest?: string | number;\n        }): boolean;\n        clear(): void;\n    };\n    logger: { info: (message: string) => void };\n    parseData: <TData extends Record<string, unknown>>(props: {\n        id: string;\n        data: TData;\n    }) => Promise<TData>;\n    generateDigest: (data: Record<string, unknown> | string) => string;\n}\n\nexport interface FlexaLoaderOptions extends Partial<FlexaClientOptions> {\n    /** Entity slug, e.g. `posts`. */\n    entity: string;\n    /** Filters for the entries to load. Defaults to published entries only. */\n    query?: Omit<ListParams, 'page'>;\n    /** Collection id of an entry. Defaults to its slug, or its id when it has none. */\n    id?: (entry: Entry) => string;\n}\n\nexport interface FlexaLoader {\n    name: string;\n    load(context: FlexaLoaderContext): Promise<void>;\n}\n\n/**\n * Load the entries of a Flexa entity into an Astro content collection.\n *\n *     // src/content.config.ts\n *     const posts = defineCollection({\n *         loader: flexaLoader({\n *             entity: 'posts',\n *             url: import.meta.env.FLEXA_URL,\n *             apiKey: import.meta.env.FLEXA_API_KEY,\n *         }),\n *     });\n *\n * `url` and `apiKey` fall back to the FLEXA_URL and FLEXA_API_KEY environment variables.\n */\nexport function flexaLoader(options: FlexaLoaderOptions): FlexaLoader {\n    const {\n        entity,\n        query = { status: 'published' },\n        id = (entry) => entry.slug ?? String(entry.id),\n        ...clientOptions\n    } = options;\n\n    return {\n        name: 'flexa-loader',\n        async load({ store, logger, parseData, generateDigest }) {\n            const url = clientOptions.url ?? process.env.FLEXA_URL;\n            const apiKey = clientOptions.apiKey ?? process.env.FLEXA_API_KEY;\n\n            if (!url || !apiKey) {\n                throw new Error(\n                    `Flexa loader \"${entity}\": set FLEXA_URL and FLEXA_API_KEY, or pass \"url\" and \"apiKey\".`,\n                );\n            }\n\n            const entries = await createClient({\n                ...clientOptions,\n                url,\n                apiKey,\n            })\n                .entity(entity)\n                .all(query);\n\n            store.clear();\n\n            for (const entry of entries) {\n                const entryId = id(entry);\n                const data = await parseData({\n                    id: entryId,\n                    data: entry as unknown as Record<string, unknown>,\n                });\n\n                store.set({\n                    id: entryId,\n                    data,\n                    digest: generateDigest(\n                        entry.updated_at ?? JSON.stringify(entry),\n                    ),\n                });\n            }\n\n            logger.info(\n                `Loaded ${entries.length} ${entries.length === 1 ? 'entry' : 'entries'} from Flexa \"${entity}\".`,\n            );\n        },\n    };\n}\n"],"mappings":";AAAA,SAAS,oBAAoB;AAG7B,cAAc;AAmDP,SAAS,YAAY,SAA0C;AAClE,QAAM;AAAA,IACF;AAAA,IACA,QAAQ,EAAE,QAAQ,YAAY;AAAA,IAC9B,KAAK,CAAC,UAAU,MAAM,QAAQ,OAAO,MAAM,EAAE;AAAA,IAC7C,GAAG;AAAA,EACP,IAAI;AAEJ,SAAO;AAAA,IACH,MAAM;AAAA,IACN,MAAM,KAAK,EAAE,OAAO,QAAQ,WAAW,eAAe,GAAG;AACrD,YAAM,MAAM,cAAc,OAAO,QAAQ,IAAI;AAC7C,YAAM,SAAS,cAAc,UAAU,QAAQ,IAAI;AAEnD,UAAI,CAAC,OAAO,CAAC,QAAQ;AACjB,cAAM,IAAI;AAAA,UACN,iBAAiB,MAAM;AAAA,QAC3B;AAAA,MACJ;AAEA,YAAM,UAAU,MAAM,aAAa;AAAA,QAC/B,GAAG;AAAA,QACH;AAAA,QACA;AAAA,MACJ,CAAC,EACI,OAAO,MAAM,EACb,IAAI,KAAK;AAEd,YAAM,MAAM;AAEZ,iBAAW,SAAS,SAAS;AACzB,cAAM,UAAU,GAAG,KAAK;AACxB,cAAM,OAAO,MAAM,UAAU;AAAA,UACzB,IAAI;AAAA,UACJ,MAAM;AAAA,QACV,CAAC;AAED,cAAM,IAAI;AAAA,UACN,IAAI;AAAA,UACJ;AAAA,UACA,QAAQ;AAAA,YACJ,MAAM,cAAc,KAAK,UAAU,KAAK;AAAA,UAC5C;AAAA,QACJ,CAAC;AAAA,MACL;AAEA,aAAO;AAAA,QACH,UAAU,QAAQ,MAAM,IAAI,QAAQ,WAAW,IAAI,UAAU,SAAS,gBAAgB,MAAM;AAAA,MAChG;AAAA,IACJ;AAAA,EACJ;AACJ;","names":[]}

package/package.json

@@ -1,6 +1,51 @@
 {
-  "name": "@flexacms/astro",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+    "name": "@flexacms/astro",
+    "version": "0.1.0",
+    "description": "Astro content loader for the Flexa headless CMS.",
+    "keywords": [
+        "astro",
+        "astro-loader",
+        "cms",
+        "content-layer",
+        "flexa",
+        "headless"
+    ],
+    "homepage": "https://github.com/flexacms/sdk/tree/main/packages/astro#readme",
+    "bugs": {
+        "url": "https://github.com/flexacms/sdk/issues"
+    },
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/flexacms/sdk.git",
+        "directory": "packages/astro"
+    },
+    "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": {
+        "astro": ">=5.0.0"
+    }
+}