@stetcms/client 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,68 @@
+# @stetcms/client
+
+Typed client for the [Stet](https://github.com/jamiedavenport/stet) API. The types come straight from the oRPC contract the server implements, so calls and responses are fully typed end to end.
+
+It also carries the content client runtime that [`@stetcms/vite`](https://github.com/jamiedavenport/stet/tree/main/published/vite)'s generated `stet.gen.ts` instantiates:
+
+```ts
+import { createContentClient } from '@stetcms/client';
+
+// Generated code passes a model type here, so `stet.posts` autocompletes and
+// each entry's `fields` match the model marketing built.
+const stet = createContentClient<Model>({ apiKey: process.env.STET_API_KEY });
+
+const posts = await stet.posts.list();
+const post = await stet.posts.get('hello-world');
+const landing = await stet.landing.get(); // a map: one entry, no slug
+```
+
+Rich text fields arrive as markdown, selects as option names, person fields as `{ id, name }`, assets as `{ id, url, name, contentType, size }` whose `url` is whole and needs no key, and references as `{ id, slug, title }` (an array for multi-reference). Keep the API key server-side: fetch content from loaders, server functions, or your own backend rather than the browser.
+
+## Install
+
+```bash
+npm install @stetcms/client
+```
+
+## Usage
+
+```ts
+import { createStetClient, safe } from '@stetcms/client';
+
+const client = createStetClient({
+  apiKey: process.env.STET_API_KEY, // organization API key (stet_...)
+});
+
+const health = await client.health();
+
+const { data: organization, error } = await safe(client.org.current());
+if (error === null) {
+  console.log(organization.name);
+}
+
+const { data: billing } = await safe(client.org.billing());
+if (billing !== undefined) {
+  // usage rows report each measured feature: { feature, used, cap, window }.
+  console.log(billing.plan, billing.usage);
+}
+```
+
+API keys are owned by an organization: an org member creates one through the Better Auth api-key endpoints (`POST /api/auth/api-key/create` with `organizationId`), and every API call made with that key is scoped to that organization.
+
+Options:
+
+- `origin`: target a local dev server or self-hosted instance (defaults to the hosted deployment).
+- `apiKey`: organization API key sent as `x-api-key`.
+- `fetch`: custom fetch implementation.
+
+The API itself is plain REST under `/api/v1`, described by the OpenAPI document generated from the same contract.
+
+## License
+
+Apache-2.0
+
+## Asset URLs
+
+The API returns asset paths relative to itself; the client joins them to the `origin` it was created with, so what you get is ready for an `img` tag on your own origin. That covers both an asset field's `url` and the images inside a rich text body, so a body renders as it stands.
+
+Calling the REST API directly instead? `assetUrl(url, origin)` joins one value and `resolveAssetPaths(markdown, origin)` joins the ones inside a body.

package/dist/codegen.d.ts

@@ -0,0 +1,37 @@
+import { DEFAULT_ORIGIN } from "@stetcms/config";
+
+//#region src/codegen.d.ts
+/** The `/api/v1/model` payload the module is generated from. */
+type ContentModel = {
+  types: {
+    slug: string;
+    name: string;
+    kind: 'collection' | 'map';
+    fields: {
+      key: string;
+      name: string;
+      type: string;
+      options: {
+        name: string;
+      }[]; /** Slug of the collection a reference field points at. */
+      collection?: string; /** Deleted from the model: emitted as a deprecation, never dropped. */
+      deprecated?: {
+        at: string;
+        by?: string;
+      };
+    }[];
+  }[];
+};
+/** Fetches the content model the given API key's organization has shaped. */
+declare function fetchContentModel(origin: string, apiKey: string): Promise<ContentModel>;
+/** `case-studies` → `CaseStudiesEntry`; never starts with a digit. */
+declare function entryTypeName(slug: string): string;
+/**
+ * Renders the generated `stet.gen.ts`: one entry type per collection or map
+ * and a `stet` client typed by them. The API key and the origin are both read
+ * from the environment at runtime, so the key is never embedded and the file
+ * is safe to commit.
+ */
+declare function renderContentModule(model: ContentModel, origin: string): string;
+//#endregion
+export { ContentModel, DEFAULT_ORIGIN, entryTypeName, fetchContentModel, renderContentModule };

package/dist/codegen.js

@@ -0,0 +1,112 @@
+import { DEFAULT_ORIGIN } from "@stetcms/config";
+//#region src/codegen.ts
+/**
+* The codegen behind `@stetcms/vite` and the CLI's `stet generate`: fetch an
+* organization's content model and render the typed `stet.gen.ts` module.
+*
+* Free of relative imports on purpose: build tools load this entry under
+* plain Node, which resolves package names but not this package's own
+* extensionless paths.
+*/
+/** Fetches the content model the given API key's organization has shaped. */
+async function fetchContentModel(origin, apiKey) {
+	const response = await fetch(`${origin}/api/v1/model`, { headers: { "x-api-key": apiKey } });
+	if (!response.ok) throw new Error(`GET ${origin}/api/v1/model responded ${response.status}`);
+	return await response.json();
+}
+/** `case-studies` → `CaseStudiesEntry`; never starts with a digit. */
+function entryTypeName(slug) {
+	const pascal = slug.split(/[^a-zA-Z0-9]+/).filter((part) => part.length > 0).map((part) => part[0].toUpperCase() + part.slice(1)).join("");
+	return /^[A-Za-z]/.test(pascal) ? `${pascal}Entry` : `Stet${pascal}Entry`;
+}
+function optionUnion(options) {
+	if (options.length === 0) return "string";
+	return options.map((option) => JSON.stringify(option.name)).join(" | ");
+}
+function fieldTsType(field) {
+	switch (field.type) {
+		case "number": return "number";
+		case "checkbox": return "boolean";
+		case "person": return "{ id: string; name: string }";
+		case "select": return optionUnion(field.options);
+		case "multi_select": return field.options.length === 0 ? "string[]" : `(${optionUnion(field.options)})[]`;
+		case "asset": return "ContentAsset";
+		case "reference": return "ContentReference";
+		case "multi_reference": return "ContentReference[]";
+		default: return "string";
+	}
+}
+/**
+* Names the change that retired the key, so whoever meets the strikethrough
+* knows when it happened and who to ask. The date is the ISO day rather than a
+* locale format, which would make the generated file differ between machines.
+*/
+function deprecationNote(deprecation) {
+	const who = deprecation.by === void 0 ? "" : ` by ${deprecation.by}`;
+	return `@deprecated Deleted from the content model on ${deprecation.at.slice(0, 10)}${who}; entries still return the last value it held, until it is purged.`;
+}
+/**
+* What the editor needs that the type cannot say: which collection a reference
+* points at, since the type is the same shape whatever the target, and whether
+* the field has been deleted from the model.
+*
+* A deleted field is emitted as a deprecation rather than dropped, and the
+* entries behind it keep answering with the last value they held. Removing it
+* would turn every read of the key into a type error, and dropping the value
+* would blank the page that read it, the moment the model was regenerated:
+* the two things a change made in the Stet UI must never do to a running site.
+*/
+function fieldDoc(field) {
+	const lines = [];
+	if (field.collection !== void 0) {
+		const target = JSON.stringify(field.collection);
+		const plural = field.type === "multi_reference" ? "References" : "Reference";
+		lines.push(`${plural} into ${target}: fetch with stet[${target}].get(slug).`);
+	}
+	if (field.deprecated !== void 0) lines.push(deprecationNote(field.deprecated));
+	return lines;
+}
+/** Renders doc lines as a comment: one line inline, several as a block. */
+function docComment(lines, indent) {
+	if (lines.length === 0) return [];
+	if (lines.length === 1) return [`${indent}/** ${lines[0]} */`];
+	return [
+		`${indent}/**`,
+		...lines.map((line) => `${indent} * ${line}`),
+		`${indent} */`
+	];
+}
+/**
+* Renders the generated `stet.gen.ts`: one entry type per collection or map
+* and a `stet` client typed by them. The API key and the origin are both read
+* from the environment at runtime, so the key is never embedded and the file
+* is safe to commit.
+*/
+function renderContentModule(model, origin) {
+	const fields = model.types.flatMap((type) => type.fields);
+	const imported = ["ContentEntryBase"];
+	if (fields.some((field) => field.type === "asset")) imported.push("ContentAsset");
+	if (fields.some((field) => field.type === "reference" || field.type === "multi_reference")) imported.push("ContentReference");
+	const lines = [
+		"// Generated by Stet from your content model. Do not edit: it is",
+		"// regenerated by @stetcms/vite or `stet generate`.",
+		"import { createContentClient } from '@stetcms/client';",
+		`import type { ${imported.join(", ")} } from '@stetcms/client';`,
+		""
+	];
+	for (const type of model.types) {
+		lines.push(`export type ${entryTypeName(type.slug)} = ContentEntryBase & {`, "  fields: {");
+		for (const field of type.fields) {
+			lines.push(...docComment(fieldDoc(field), "    "));
+			lines.push(`    ${JSON.stringify(field.key)}?: ${fieldTsType(field)} | null;`);
+		}
+		lines.push("  };", "};", "");
+	}
+	lines.push("export type StetContentModel = {");
+	for (const type of model.types) lines.push(`  ${JSON.stringify(type.slug)}: { kind: ${JSON.stringify(type.kind)}; entry: ${entryTypeName(type.slug)} };`);
+	lines.push("};", "");
+	lines.push("const origin =", `  typeof process === 'undefined' ? ${JSON.stringify(origin)} : (process.env.STET_ORIGIN ?? ${JSON.stringify(origin)});`, "", "export const stet = createContentClient<StetContentModel>({", "  origin,", "  apiKey: typeof process === 'undefined' ? undefined : process.env.STET_API_KEY,", "});", "");
+	return lines.join("\n");
+}
+//#endregion
+export { DEFAULT_ORIGIN, entryTypeName, fetchContentModel, renderContentModule };