Skip to content

README.md

Latest commit

 

History

History
60 lines (45 loc) · 1.24 KB

README.md

File metadata and controls

60 lines (45 loc) · 1.24 KB

Ominity Blog API Module

This is the Blog module for the Ominity API, plugging into @ominity/api-typescript.

Install

npm install @ominity/api-typescript @ominity/api-modules-blog

Usage (example)

import { Ominity } from "@ominity/api-typescript";
import { blogModule, BlogModule } from "@ominity/api-modules-blog";

const ominity = new Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  security: { apiKey: process.env["OMINITY_API_KEY"] ?? "" },
});

// Either option is supported
ominity.use(BlogModule);
// or
ominity.use(blogModule());

// Constructor option
const ominity2 = new Ominity({
  serverURL: "https://tenant-a.ominity.com/api",
  security: { apiKey: process.env["OMINITY_API_KEY"] ?? "" },
  modules: [blogModule()],
});

const res = await ominity.modules.blog.posts.list({ page: 1, limit: 20 });
console.log(res.items);

Structure

src/
  funcs/
  models/
  models/operations/
  sdk/
  index.ts

Development

npm run lint
npm run build

Notes

  • This template mirrors the core SDK architecture (models, operations, funcs, sdk).
  • HAL responses are transformed; public types should not expose _links or _embedded.
  • Use zod/v4 and .loose() for forward compatibility.