@omerlo/omerlo-webkit 0.0.12 → 0.0.14

package/README.md

@@ -60,7 +60,7 @@ Then you need to use the component `OmerloWebkit` and give him the `userSession`
 ```ts
 // +layout.svelte
 <script lang="ts">
-  import { OmerloWebkit } from 'omerlo-webkit'
+  import { OmerloWebkit } from '$omerlo'
   let { data, children } = $props();
 </script>
 
@@ -76,7 +76,7 @@ To use reader API, you can use the function `useReader` passing the sveltekit `f
 ```ts
 // +page.ts
 import type { PageLoad } from './$types';
-import { useReader } from 'omerlo-webkit';
+import { useReader } from '$omerlo';
 
 export const load: PageLoad = async ({ fetch }) => {
   const oauthProviders = await useReader(fetch).listOauthProviders();

package/dist/omerlo/index.d.ts

@@ -8,7 +8,7 @@ export declare const useReader: (f: typeof fetch) => {
         getIssue: (id: string) => Promise<import("./reader/utils/api").ApiResponse<import("./reader").Issue>>;
         getBlocks: (sectionId: string) => Promise<import("./reader/utils/api").ApiResponse<import("./reader").IssueBlock[]>>;
         searchContents: (issueId: string, q: string) => Promise<import("./reader/utils/api").ApiResponse<import("./reader").SectionContent[]>>;
-        getSectionContents: (sectionId: string) => Promise<import("./reader/utils/api").ApiResponse<import("./reader").Content[]>>;
+        getSectionContents: (sectionId: string) => Promise<import("./reader/utils/api").ApiResponse<import("./reader").ContentSummary[]>>;
     };
     getMenu: (key: string) => Promise<import("./reader/utils/api").ApiResponse<import("./reader").Menu>>;
     listMenus: (params?: Partial<import("./reader/utils/api").PagingParams>) => Promise<import("./reader/utils/api").ApiResponse<import("./reader").MenuSummary[]>>;
@@ -36,6 +36,7 @@ export declare const useReader: (f: typeof fetch) => {
     getOauthUser: () => Promise<import("./reader/utils/api").ApiResponse<import("./reader").OauthUser>>;
     registerDevice: (params: import("./reader").DeviceParams) => Promise<import("./reader/utils/api").ApiResponse<unknown>>;
     userInfo: () => Promise<import("./reader/utils/api").ApiResponse<import("./reader").UserInfo>>;
+    userEntitlements: () => Promise<import("./reader/utils/api").ApiResponse<import("./reader").UserEntitlement[]>>;
     verifyAccount: (params: import("./reader").VerifyAccountParams) => void;
     validateAccount: (params: import("./reader").ValidateAccountParams) => void;
 };

package/dist/omerlo/reader/endpoints/accounts.d.ts

@@ -1,5 +1,6 @@
 export declare const accountsFetchers: (f: typeof fetch) => {
     userInfo: () => Promise<import("../utils/api").ApiResponse<UserInfo>>;
+    userEntitlements: () => Promise<import("../utils/api").ApiResponse<UserEntitlement[]>>;
     verifyAccount: (params: VerifyAccountParams) => void;
     validateAccount: (params: ValidateAccountParams) => void;
 };
@@ -17,3 +18,8 @@ export interface UserInfo {
     name: string;
     email: string;
 }
+export declare function getUserEntitlements(f: typeof fetch): () => Promise<import("../utils/api").ApiResponse<UserEntitlement[]>>;
+export interface UserEntitlement {
+    id: string;
+    feature_key: string;
+}

package/dist/omerlo/reader/endpoints/accounts.js

@@ -1,7 +1,9 @@
+import { parseMany } from '../utils/api';
 import { request } from '../utils/request';
 export const accountsFetchers = (f) => {
     return {
         userInfo: getUserInfo(f),
+        userEntitlements: getUserEntitlements(f),
         verifyAccount: verifyAccount(f),
         validateAccount: validateAccount(f)
     };
@@ -40,3 +42,18 @@ function parseUserInfo(data, _assoc) {
         email: data.email
     };
 }
+//
+// Get user's entitlements associated to the bearer token (Platform).
+//
+export function getUserEntitlements(f) {
+    return async () => {
+        const opts = { parser: parseMany(parseUserEntitlement) };
+        return request(f, '/account/me/entitlements', opts);
+    };
+}
+function parseUserEntitlement(data, _assoc) {
+    return {
+        id: data.id,
+        feature_key: data.feature_key
+    };
+}

package/dist/omerlo/reader/endpoints/contents.d.ts

@@ -10,8 +10,8 @@ export declare const contentsFetchers: (f: typeof fetch) => {
     listContents: (params?: Partial<PagingParams>) => Promise<import("../utils/api").ApiResponse<ContentSummary[]>>;
 };
 export interface ContentSeo {
-    title: string;
-    description: string;
+    title: string | null;
+    description: string | null;
 }
 export interface ContentSummary {
     id: string;
@@ -37,6 +37,7 @@ export interface ContentSummary {
     authors: (PersonSummary | OrganizationSummary)[];
 }
 export interface Content extends ContentSummary {
+    seo: ContentSeo;
     blocks: ContentBlock[];
 }
 export type ContentBlockRichtext = {
@@ -73,7 +74,7 @@ export type ContentBlockQuote = {
 export type ContentBlockRelatedContents = {
     id: string;
     kind: 'related-contents';
-    contents: Content[];
+    contents: ContentSummary[];
     visual: Visual | null;
     template: ContentBlockTemplate | null;
 };

package/dist/omerlo/reader/endpoints/contents.js

@@ -116,7 +116,7 @@ function getBlockTemplate(data, assocs) {
         ? getAssoc(assocs, 'block_templates', data.template_id)
         : null;
 }
-function getBlockContent(data, assocs) {
+function getBlockContents(data, assocs) {
     return data.related_contents ? getAssocs(assocs, 'contents', data.related_contents) : [];
 }
 function parseContentBlockRichtext(data, assocs) {
@@ -147,7 +147,7 @@ function parseContentBlockQuote(data, assocs) {
     };
 }
 function parseContentBlockRelatedContents(data, assocs) {
-    const contents = getBlockContent(data, assocs);
+    const contents = getBlockContents(data, assocs);
     return {
         ...baseBlock(data, assocs),
         contents

package/dist/omerlo/reader/endpoints/magazines.d.ts

@@ -1,17 +1,17 @@
 import { type LocalesMetadata } from '../utils/response';
 import { type Visual } from './visuals';
 import { type ApiAssocs, type ApiData } from '../utils/api';
-import { type Content, type ContentSummary } from './contents';
+import { type ContentSummary } from './contents';
 export declare const magazineFetchers: (f: typeof fetch) => {
     getIssue: (id: string) => Promise<import("../utils/api").ApiResponse<Issue>>;
     getBlocks: (sectionId: string) => Promise<import("../utils/api").ApiResponse<IssueBlock[]>>;
     searchContents: (issueId: string, q: string) => Promise<import("../utils/api").ApiResponse<SectionContent[]>>;
-    getSectionContents: (sectionId: string) => Promise<import("../utils/api").ApiResponse<Content[]>>;
+    getSectionContents: (sectionId: string) => Promise<import("../utils/api").ApiResponse<ContentSummary[]>>;
 };
 export declare function issueFetcher(f: typeof fetch): (id: string) => Promise<import("../utils/api").ApiResponse<Issue>>;
 export declare function issueBlocksFetcher(f: typeof fetch): (sectionId: string) => Promise<import("../utils/api").ApiResponse<IssueBlock[]>>;
 export declare function contentsSearch(f: typeof fetch): (issueId: string, q: string) => Promise<import("../utils/api").ApiResponse<SectionContent[]>>;
-export declare function sectionContentsFetcher(f: typeof fetch): (sectionId: string) => Promise<import("../utils/api").ApiResponse<Content[]>>;
+export declare function sectionContentsFetcher(f: typeof fetch): (sectionId: string) => Promise<import("../utils/api").ApiResponse<ContentSummary[]>>;
 /******************************************************************************
  * Parsers
  ******************************************************************************/
@@ -23,7 +23,7 @@ export declare function parseIssueBlock(data: ApiData, assocs: ApiAssocs): Issue
 export declare function parseIssueBlockSlot(data: ApiData, assocs: ApiAssocs): IssueBlockSlot;
 export declare function parseIssueSectionContent(data: ApiData, assocs: ApiAssocs): SectionContent;
 export declare function parseIssueType(data: ApiData, _assocs: ApiAssocs): IssueType;
-export declare function parseIssueBlockConfiguration(data: ApiData, assocs: ApiAssocs): IssueBlockConfiguration;
+export declare function parseIssueBlockConfiguration(data: ApiData): IssueBlockConfiguration;
 /******************************************************************************
  * Interfaces
  ******************************************************************************/
@@ -88,7 +88,7 @@ export interface IssueBlock {
     };
     updatedAt: Date;
 }
-export interface SectionContent extends Content {
+export interface SectionContent extends ContentSummary {
     section: IssueSectionSummary;
 }
 export interface IssueBlockConfiguration {

package/dist/omerlo/reader/endpoints/magazines.js

@@ -3,7 +3,7 @@ import { parseVisual } from './visuals';
 import { parseMany } from '../utils/api';
 import { getAssoc } from '../utils/assocs';
 import { request } from '../utils/request';
-import { parseContent } from './contents';
+import { parseContentSummary } from './contents';
 export const magazineFetchers = (f) => {
     return {
         getIssue: issueFetcher(f),
@@ -32,7 +32,7 @@ export function contentsSearch(f) {
 }
 export function sectionContentsFetcher(f) {
     return async (sectionId) => {
-        const opts = { parser: parseMany(parseContent) };
+        const opts = { parser: parseMany(parseContentSummary) };
         return request(f, `/issues/sections/${sectionId}/contents`, opts);
     };
 }
@@ -108,7 +108,7 @@ export function parseIssueBlockSlot(data, assocs) {
 }
 export function parseIssueSectionContent(data, assocs) {
     return {
-        ...parseContent(data, assocs),
+        ...parseContentSummary(data, assocs),
         section: getAssoc(assocs, 'issue_sections', data.section_id)
     };
 }
@@ -124,7 +124,7 @@ export function parseIssueType(data, _assocs) {
         updatedAt: new Date(data.updated_at)
     };
 }
-export function parseIssueBlockConfiguration(data, assocs) {
+export function parseIssueBlockConfiguration(data) {
     return {
         id: data.id,
         key: data.key,

package/dist/omerlo/reader/endpoints/profiles.d.ts

@@ -4,7 +4,7 @@ import { type EventSummary } from './events';
 import { type Organization, type OrganizationSummary } from './organizations';
 import type { ApiAssocs, ApiData } from '../utils/api';
 import type { LocalesMetadata } from '../utils/response';
-import type { Content } from './contents';
+import type { ContentSummary } from './contents';
 import { type Image, type Slideshow, type Video } from './visuals';
 export type Profile = Person | Project | Event | Organization;
 export type ProfileSummary = PersonSummary | ProjectSummary | EventSummary | OrganizationSummary;
@@ -58,7 +58,7 @@ export type ProfileBlock = {
     updatedAt: Date;
 };
 export interface ProfileBlockContents extends ProfileBlock {
-    contents: Content[];
+    contents: ContentSummary[];
 }
 export interface ProfileBlockRelations extends ProfileBlock {
     profiles: ProfileSummary[];

package/dist/omerlo/reader/fetchers.d.ts

@@ -8,7 +8,7 @@ export declare const fetchers: (f: typeof fetch) => {
         getIssue: (id: string) => Promise<import("./utils/api").ApiResponse<import("./endpoints/magazines").Issue>>;
         getBlocks: (sectionId: string) => Promise<import("./utils/api").ApiResponse<import("./endpoints/magazines").IssueBlock[]>>;
         searchContents: (issueId: string, q: string) => Promise<import("./utils/api").ApiResponse<import("./endpoints/magazines").SectionContent[]>>;
-        getSectionContents: (sectionId: string) => Promise<import("./utils/api").ApiResponse<import("./endpoints/contents").Content[]>>;
+        getSectionContents: (sectionId: string) => Promise<import("./utils/api").ApiResponse<import("./endpoints/contents").ContentSummary[]>>;
     };
     getMenu: (key: string) => Promise<import("./utils/api").ApiResponse<import("./endpoints/menu").Menu>>;
     listMenus: (params?: Partial<import("./utils/api").PagingParams>) => Promise<import("./utils/api").ApiResponse<import("./endpoints/menu").MenuSummary[]>>;
@@ -36,6 +36,7 @@ export declare const fetchers: (f: typeof fetch) => {
     getOauthUser: () => Promise<import("./utils/api").ApiResponse<import("./endpoints/oauth").OauthUser>>;
     registerDevice: (params: import("./endpoints/device").DeviceParams) => Promise<import("./utils/api").ApiResponse<unknown>>;
     userInfo: () => Promise<import("./utils/api").ApiResponse<import("./endpoints/accounts").UserInfo>>;
+    userEntitlements: () => Promise<import("./utils/api").ApiResponse<import("./endpoints/accounts").UserEntitlement[]>>;
     verifyAccount: (params: import("./endpoints/accounts").VerifyAccountParams) => void;
     validateAccount: (params: import("./endpoints/accounts").ValidateAccountParams) => void;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omerlo/omerlo-webkit",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "scripts": {
     "dev": "vite dev",
     "build": "vite build && npm run package",