@mhbdev/unicms 0.1.0

package/README.md

@@ -0,0 +1,117 @@
+# @mhbdev/unicms
+
+Typed SDK for the UniCMS public API (`/api/public/v1/*`).
+
+## Install
+
+```bash
+pnpm add @mhbdev/unicms
+```
+
+## Create client
+
+```ts
+import { createUniCmsClient } from '@mhbdev/unicms'
+
+const cms = createUniCmsClient({
+  baseUrl: 'https://cms.example.com',
+  tenant: { slug: 'acme' },
+})
+```
+
+Use domain-based tenant scope instead:
+
+```ts
+const cms = createUniCmsClient({
+  baseUrl: 'https://cms.example.com',
+  tenant: { domain: 'acme.example.com' },
+})
+```
+
+## Optional auth headers (private tenants)
+
+```ts
+const cms = createUniCmsClient({
+  baseUrl: 'https://cms.example.com',
+  tenant: { slug: 'acme' },
+  headers: async () => ({
+    Authorization: `Bearer ${await getToken()}`,
+  }),
+})
+```
+
+## API
+
+```ts
+await cms.getSiteSettings()
+await cms.getPageBySlug('home')
+await cms.getPageBySlug('pricing', { includeRawContent: true })
+
+await cms.listPosts({ page: 1, limit: 10, q: 'cms', categorySlug: 'news', tagSlug: 'payload' })
+await cms.getPostBySlug('hello-world')
+await cms.getPostBySlug('hello-world', { includeRawContent: true })
+
+await cms.listFaqs()
+await cms.listFaqs({ includeRawContent: true })
+
+await cms.listCategories()
+await cms.listTags()
+```
+
+## Error handling
+
+SDK methods throw `UniCmsError`:
+
+```ts
+import { UniCmsError } from '@mhbdev/unicms'
+
+try {
+  await cms.getPageBySlug('missing-page')
+} catch (error) {
+  if (error instanceof UniCmsError) {
+    console.error(error.code, error.status, error.message, error.details)
+  }
+}
+```
+
+Error codes:
+- `BAD_REQUEST`
+- `UNAUTHORIZED`
+- `FORBIDDEN`
+- `NOT_FOUND`
+- `VALIDATION_ERROR`
+- `NETWORK_ERROR`
+- `PARSE_ERROR`
+- `UNKNOWN`
+
+## Pagination
+
+`listPosts` returns:
+
+```ts
+type Paginated<T> = {
+  docs: T[]
+  pagination: {
+    page: number
+    limit: number
+    totalDocs: number
+    totalPages: number
+    hasNextPage: boolean
+    hasPrevPage: boolean
+    nextPage: number | null
+    prevPage: number | null
+  }
+}
+```
+
+Defaults: `page=1`, `limit=10`, max `limit=50`.
+
+## Compatibility
+
+- SDK targets UniCMS public API v1.
+- Endpoints are expected at `/api/public/v1/*`.
+- v1 returns published content only.
+
+## Release notes
+
+- `0.1.x`: Initial v1 contract-first release.

package/dist/client.d.ts

@@ -0,0 +1,3 @@
+import type { UniCmsClient, UniCmsClientOptions } from './types.js';
+export declare const createUniCmsClient: (options: UniCmsClientOptions) => UniCmsClient;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAYnE,eAAO,MAAM,kBAAkB,GAAI,SAAS,mBAAmB,KAAG,YAcjE,CAAA"}

package/dist/client.js

@@ -0,0 +1,30 @@
+import { createHttpClient } from './http.js';
+import { getPageBySlug } from './methods/getPageBySlug.js';
+import { getPostBySlug } from './methods/getPostBySlug.js';
+import { getSiteSettings } from './methods/getSiteSettings.js';
+import { listCategories } from './methods/listCategories.js';
+import { listFaqs } from './methods/listFaqs.js';
+import { listPosts } from './methods/listPosts.js';
+import { listTags } from './methods/listTags.js';
+const assertTenantScope = (options) => {
+    if ('slug' in options.tenant && !options.tenant.slug.trim()) {
+        throw new Error('tenant.slug must be a non-empty string');
+    }
+    if ('domain' in options.tenant && !options.tenant.domain.trim()) {
+        throw new Error('tenant.domain must be a non-empty string');
+    }
+};
+export const createUniCmsClient = (options) => {
+    assertTenantScope(options);
+    const http = createHttpClient(options);
+    return {
+        getSiteSettings: () => getSiteSettings(http),
+        getPageBySlug: (slug, opts) => getPageBySlug(http, slug, opts),
+        listPosts: (params) => listPosts(http, params),
+        getPostBySlug: (slug, opts) => getPostBySlug(http, slug, opts),
+        listFaqs: (opts) => listFaqs(http, opts),
+        listCategories: () => listCategories(http),
+        listTags: () => listTags(http),
+    };
+};
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAGhD,MAAM,iBAAiB,GAAG,CAAC,OAA4B,EAAE,EAAE;IACzD,IAAI,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;IAC3D,CAAC;IAED,IAAI,QAAQ,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;QAChE,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;IAC7D,CAAC;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAA4B,EAAgB,EAAE;IAC/E,iBAAiB,CAAC,OAAO,CAAC,CAAA;IAE1B,MAAM,IAAI,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAA;IAEtC,OAAO;QACL,eAAe,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC;QAC5C,aAAa,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;QAC9D,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;QAC9C,aAAa,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;QAC9D,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;QACxC,cAAc,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC;QAC1C,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;KAC/B,CAAA;AACH,CAAC,CAAA"}